-
Notifications
You must be signed in to change notification settings - Fork 743
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into http-sender
- Loading branch information
Showing
104 changed files
with
1,065 additions
and
682 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| name: Lint | ||
|
|
||
| on: [push, pull_request] | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v2 | ||
|
|
||
| - name: restore lerna | ||
| uses: actions/cache@master # must use unreleased master to cache multiple paths | ||
| id: cache | ||
| with: | ||
| path: | | ||
| node_modules | ||
| packages/*/node_modules | ||
| metapackages/*/node_modules | ||
| key: ${{ runner.os }}-${{ hashFiles('**/package.json') }} | ||
|
|
||
| - name: Bootstrap | ||
| if: steps.cache.outputs.cache-hit != 'true' | ||
| run: | | ||
| npm install --only=dev --ignore-scripts | ||
| npx lerna bootstrap --no-ci --ignore-scripts -- --only=dev | ||
| - name: Lint | ||
| run: | | ||
| npm run lint | ||
| npm run lint:examples | ||
| - name: Install and Build API Dependencies | ||
| run: npx lerna bootstrap --no-ci --scope @opentelemetry/api --include-filtered-dependencies | ||
|
|
||
| - name: Test Docs | ||
| run: npm run docs-test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| # Batcher API Guide | ||
|
|
||
| [The batcher](https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-metrics/src/export/Batcher.ts?rgh-link-date=2020-05-25T18%3A43%3A57Z) has two responsibilities: choosing which aggregator to choose for a metric instrument and store the last record for each metric ready to be exported. | ||
|
|
||
| ## Selecting a specific aggregator for metrics | ||
|
|
||
| Sometimes you may want to use a specific aggregator for one of your metric, export an average of the last X values instead of just the last one. | ||
|
|
||
| Here is what an aggregator that does that would look like: | ||
| ```ts | ||
| import { Aggregator } from '@opentelemetry/metrics'; | ||
| import { hrTime } from '@opentelemetry/core'; | ||
|
|
||
| export class AverageAggregator implements Aggregator { | ||
|
|
||
| private _values: number[] = []; | ||
| private _limit: number; | ||
|
|
||
| constructor (limit?: number) { | ||
| this._limit = limit ?? 10; | ||
| } | ||
|
|
||
| update (value: number) { | ||
| this._values.push(value); | ||
| if (this._values.length >= this._limit) { | ||
| this._values = this._values.slice(0, 10); | ||
| } | ||
| } | ||
|
|
||
| toPoint() { | ||
| const sum =this._values.reduce((agg, value) => { | ||
| agg += value; | ||
| return agg; | ||
| }, 0); | ||
| return { | ||
| value: this._values.length > 0 ? sum / this._values.length : 0, | ||
| timestamp: hrTime(), | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Now we will need to implement our own batcher to configure the sdk to use our new aggregator. To simplify even more, we will just extend the `UngroupedBatcher` (which is the default) to avoid re-implementing the whole `Aggregator` interface. | ||
|
|
||
| Here the result: | ||
| ```ts | ||
| import { | ||
| UngroupedBatcher, | ||
| MetricDescriptor, | ||
| CounterSumAggregator, | ||
| ObserverAggregator, | ||
| MeasureExactAggregator, | ||
| } from '@opentelemetry/metrics'; | ||
|
|
||
| export class CustomBatcher extends UngroupedBatcher { | ||
| aggregatorFor (metricDescriptor: MetricDescriptor) { | ||
| if (metricDescriptor.labels === 'metricToBeAveraged') { | ||
| return new AverageAggregator(10); | ||
| } | ||
| // this is exactly what the "UngroupedBatcher" does, we will re-use it | ||
| // to fallback on the default behavior | ||
| switch (metricDescriptor.metricKind) { | ||
| case MetricKind.COUNTER: | ||
| return new CounterSumAggregator(); | ||
| case MetricKind.OBSERVER: | ||
| return new ObserverAggregator(); | ||
| default: | ||
| return new MeasureExactAggregator(); | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Finally, we need to specify to the `MeterProvider` to use our `CustomBatcher` when creating new meter: | ||
|
|
||
| ```ts | ||
| import { | ||
| UngroupedBatcher, | ||
| MetricDescriptor, | ||
| CounterSumAggregator, | ||
| ObserverAggregator, | ||
| MeasureExactAggregator, | ||
| MeterProvider, | ||
| Aggregator, | ||
| } from '@opentelemetry/metrics'; | ||
| import { hrTime } from '@opentelemetry/core'; | ||
|
|
||
| export class AverageAggregator implements Aggregator { | ||
|
|
||
| private _values: number[] = []; | ||
| private _limit: number; | ||
|
|
||
| constructor (limit?: number) { | ||
| this._limit = limit ?? 10; | ||
| } | ||
|
|
||
| update (value: number) { | ||
| this._values.push(value); | ||
| if (this._values.length >= this._limit) { | ||
| this._values = this._values.slice(0, 10); | ||
| } | ||
| } | ||
|
|
||
| toPoint() { | ||
| const sum =this._values.reduce((agg, value) => { | ||
| agg += value; | ||
| return agg; | ||
| }, 0); | ||
| return { | ||
| value: this._values.length > 0 ? sum / this._values.length : 0, | ||
| timestamp: hrTime(), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| export class CustomBatcher extends UngroupedBatcher { | ||
| aggregatorFor (metricDescriptor: MetricDescriptor) { | ||
| if (metricDescriptor.name === 'requests') { | ||
| return new AverageAggregator(10); | ||
| } | ||
| // this is exactly what the "UngroupedBatcher" does, we will re-use it | ||
| // to fallback on the default behavior | ||
| switch (metricDescriptor.metricKind) { | ||
| case MetricKind.COUNTER: | ||
| return new CounterSumAggregator(); | ||
| case MetricKind.OBSERVER: | ||
| return new ObserverAggregator(); | ||
| default: | ||
| return new MeasureExactAggregator(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| const meter = new MeterProvider({ | ||
| batcher: new CustomBatcher(), | ||
| interval: 1000, | ||
| }).getMeter('example-custom-batcher'); | ||
|
|
||
| const requestsLatency = meter.createMeasure('requests', { | ||
| monotonic: true, | ||
| description: 'Average latency' | ||
| }); | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.