Skip to content

Commit

Permalink
more readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jakthom committed Nov 8, 2024
1 parent d3439fd commit 46277cf
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Launching Hercules in a Codespace is the easiest way to get started.

# Sources

Hercules materializes Prometheus metrics by querying:
Hercules generates Prometheus metrics by querying:

- **Local files** (parquet, json, csv, xlsx, etc)
- **Object storage** (GCS, S3, Azure Blob)
Expand All @@ -54,7 +54,7 @@ Hercules supports Prometheus **gauges, counters, summaries, and histograms.**

### Enrichment

Sources and can be *externally enriched*, leading to more ***thorough***, ***accurate*** (or is it precise?), ***properly-labeled*** metrics.
Sources and metrics can be *externally enriched*, leading to more ***thorough***, ***accurate*** (or is it precise?), ***properly-labeled*** metrics.

Integrate, calculate, enrich, and label on the edge.

Expand All @@ -64,7 +64,7 @@ Integrate, calculate, enrich, and label on the edge.

Metric definitions can be kept DRY using SQL macros.

Macros are useful for operations like:
Macros are useful for:

- Parsing log lines
- Reading useragent strings
Expand All @@ -73,7 +73,6 @@ Macros are useful for operations like:
- Tokenizing attributes



# Labels

Hercules propagates global labels to all configured metrics. So you don't have to guess where a metric came from.
Expand All @@ -85,8 +84,7 @@ Labels are propagated from configuration or sourced from environment variables.

Hercules extensions, sources, metrics, and macros can be logically grouped and distributed by the use of **packages**.

Starter packages can be found in the [hercules-packages](/hercules-packages/) directory.

Examples can be found in the [hercules-packages](/hercules-packages/) directory.


# Bonus
Expand Down

0 comments on commit 46277cf

Please sign in to comment.