Skip to content

Commit

Permalink
doc: Provide capability to define metric window starting point to que…
Browse files Browse the repository at this point in the history
…ry Azure Monitor (#32)
  • Loading branch information
tomkerkhove authored Aug 13, 2022
1 parent 2683482 commit 47f816f
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/scraping/runtime-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ metricSinks:
metricPrefix: promitor. # Optional. Default: None
metricsConfiguration:
absolutePath: /config/metrics-declaration.yaml # Optional. Default: /config/metrics-declaration.yaml
azureMonitor:
logging:
informationLevel: Basic # Optional. Default: Basic
isEnabled: false # Optional. Default: false
integration:
history:
startingFromInHours: 24 # Optional. Default: 12
telemetry:
applicationInsights:
instrumentationKey: ABC # Optional. Note: Required to be specified when turned on
Expand Down Expand Up @@ -345,6 +352,8 @@ The behavior of this can be configured to fit your needs:
options are `Basic`, `Headers`, `Body` & `BodyAndHeaders`. (Default: `Basic`)
- `azureMonitor.logging.isEnabled` - Defines whether or not information concerning the integration with Azure Monitor
API. (Default: `false`)
- `azureMonitor.integration.history.startingFromInHours` - Defines the amount of hours Promitor will use to define the starting point of the time window used for metric queries.
- As an example, the default is 12 hours which means Promitor will fetch all metrics between now - 12 hours and now to find a matching metric. Typically this window can be very small but Promitor provides a margin by default to prevent problems for long aggregation periods. (Default: `12`)

Example:

Expand All @@ -353,6 +362,9 @@ azureMonitor:
logging:
informationLevel: Basic # Optional. Default: Basic
isEnabled: false # Optional. Default: false
integration:
history:
startingFromInHours: 24 # Optional. Default: 12
```

_Note: All telemetry is emitted as `trace` so you have to make sure `telemetry` is configured correctly._
Expand Down

0 comments on commit 47f816f

Please sign in to comment.