Skip to content

Commit

Permalink
fix(doc): update aggregation part in the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
manushak committed Aug 7, 2024
1 parent 1612a62 commit 27fce36
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions Refactor-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,9 +199,7 @@ The aggregate plugin aggregates data in two ways: first it condenses individual
This is a builtin feature of IF, meaning it does not have to be initialized as a plugin. Instead, you just have to include a short config block in the top of the manifest file. There are two pieces of information required:
- `metrics`: which metrics do you want to aggregate? Every metric you provide here must exist in the output array.
- `method`: the aggregation method for the specied metric
- `metrics`: which metrics do you want to aggregate? Every metric you provide here must exist in the output array and be described in the `parameter-metadata` of the plugin.
- `type`: the options are `horizontal`, `vertical` or both. Horizontal aggregation is the type that condenses each time series into a single summary value. Vertical aggregation is aggregated across components.
Expand All @@ -210,8 +208,7 @@ Here's what the config block should look like:
```yaml
aggregation:
metrics:
'carbon':
method: 'sum'
- carbon
type: 'both'
```
Expand Down

0 comments on commit 27fce36

Please sign in to comment.