Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mistodon committed Jul 18, 2022
1 parent 24acf48 commit 67977af
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions processor/cumulativetodeltaprocessor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

## Description

The cumulative to delta processor (`cumulativetodeltaprocessor`) converts monotonic, cumulative sum metrics to monotonic, delta sum metrics. Non-monotonic sums are excluded.
The cumulative to delta processor (`cumulativetodeltaprocessor`) converts monotonic, cumulative sum and histogram metrics to monotonic, delta metrics. Non-monotonic sums are excluded.

## Configuration

Expand All @@ -31,7 +31,7 @@ processors:
# processor name: cumulativetodelta
cumulativetodelta:

# list the exact cumulative sum metrics to convert to delta
# list the exact cumulative sum or histogram metrics to convert to delta
include:
metrics:
- <metric_1_name>
Expand All @@ -47,8 +47,8 @@ processors:
# processor name: cumulativetodelta
cumulativetodelta:

# Convert cumulative sum metrics to delta
# if and only if 'metric' is in the name
# Convert cumulative sum or histogram metrics to delta
# if and only if 'metric' is in the name
include:
metrics:
- "*metric*"
Expand All @@ -60,8 +60,8 @@ processors:
# processor name: cumulativetodelta
cumulativetodelta:

# Convert cumulative sum metrics to delta
# if and only if 'metric' is not in the name
# Convert cumulative sum or histogram metrics to delta
# if and only if 'metric' is not in the name
exclude:
metrics:
- "*metric*"
Expand All @@ -73,7 +73,7 @@ processors:
# processor name: cumulativetodelta
cumulativetodelta:
# If include/exclude are not specified
# convert all cumulative sum metrics to delta
# convert all cumulative sum or histogram metrics to delta
```

## Warnings
Expand Down

0 comments on commit 67977af

Please sign in to comment.