Skip to content

Commit

Permalink
Fix metrics environment variables in doc (Azure#3673)
Browse files Browse the repository at this point in the history
  • Loading branch information
@lfitchett
lfitchett authored Oct 19, 2020
1 parent 2f9bd21 commit 8482e98
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions doc/EnvironmentVariables.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@
| K8sNamespace | K8s namespace to use for deploying modules | string | |
| LocalConfigPath | Path to local .json file containing Agent config | string | .\config.json |
| MaxRestartCount | Max number of restarts allowed before a module is considered to have failed | int32 | |
| MetricScrapeInterval | Interval at which diagnostic metrics are sampled | TimeSpan string | 1 hour |
| MetricUploadInterval | Interval at which diagnostic metrics are uploaded | TimeSpan string | 1 day |
| MetricsEnabled | Whether to enable metrics listener | bool | true |
| MetricsHistogramMaxAge | Time interval for the metrics histogram | TimeSpan string | 00:01:00 (1 hour)
| MetricScrapeInterval | Interval at which diagnostic metrics are sampled | TimeSpan string | 00:01:00 (1 hour) |
| MetricUploadInterval | Interval at which diagnostic metrics are uploaded | TimeSpan string | 01:00:00 (1 day) |
| PerformanceMetricsUpdateFrequency | Interval to sample system performance metrics from host. These include CPU, RAM and Disk Space measurements. | TimeSpan string | 00:00:05 (5 minutes) |
| Mode | specifies the mode for module deployment | iotedged, docker, kubernetes | iotedged |
| PerformanceMetricsUpdateFrequency | Interval to sample system performance metrics | TimeSpan string | 5 minutes |
| PersistentVolumeClaimDefaultSizeInMb | Size of the PersistedVolumeClaim, must be used with StorageClassName | int32 | |
| RequestTimeoutSecs | Timeout for handling ping and GetTaskStatus direct methods | int32 | 600 |
| RocksDB_MaxOpenFiles | Max number of files to be concurrently opened by RocksDB | int32 | |
Expand All @@ -32,7 +34,7 @@
| UsePersistentStorage | Whether to save deployment config and module states to disk | bool | true |
| UseServerHeartbeat | Sets the client-side heartbeat interval to 60sec for the Agent's upstream AMQP connection | bool | true |

## EdegHub
## EdgeHub
| Variable | Description | Values | Default |
|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|-------------------------------|
| amqpSettings:enabled | Whether the AMQP protocol head should be enabled | bool | true |
Expand Down Expand Up @@ -61,7 +63,7 @@
| MessageAckTimeoutSecs | Time span to wait for sending a message downstream to a leaf device | int32 | 30 |
| metrics:listener:host | Hostname of the metrics listener, used to construct the metrics listener URL | string | * |
| metrics:listener:MetricsEnabled | Whether to enable metrics listener | bool | true |
| metrics:listener:MetricsHistogramMaxAge | Time interval (in hours) for the metrics histogram | int32 | 1 |
| metrics:listener:MetricsHistogramMaxAge | Time interval for the metrics histogram | TimeSpan string | 00:01:00 (1 hour) |
| metrics:listener:port | Port of the metrics listener, used to construct the metrics listener URL | int32 | 9600 |
| metrics:listener:suffix | Appended to the metrics listener URL | string | metrics |
| MinTwinSyncPeriodSecs | Maximum frequency for pull any device/module twin | int32 | 120 |
Expand Down

0 comments on commit 8482e98

Please sign in to comment.