Skip to content

Commit

Permalink
Merge pull request #363 from sentrysoftware/feature/issue-146-documen…
Browse files Browse the repository at this point in the history
…t-connector-variables

Issue #146:  Document connector variables
  • Loading branch information
NassimBtk committed Aug 9, 2024
2 parents c25c1d8 + e023ebc commit c5cf9d2
Showing 1 changed file with 22 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -813,6 +813,28 @@ $ metricshub -l

For more information about the `metricshub` command, refer to [MetricsHub CLI (metricshub)](../troubleshooting/cli.md).

#### Configure Connector Variables

In **MetricsHub**, connector variables are essential for customizing the behavior of data collection. The connector variables are configured in the `metricshub.yaml` file under the `variables` section of your configured resource. These variables are specified under the name of the connector to which they belong and contain key-value pairs. The key of each variable corresponds to a variable already configured in the connector.

* Example :

Below is a configuration using the `WindowsProcess` connector. The `processName` variable, defined in the variables section, specifies a list of process names (msedge.exe and metricshub.exe) to monitor:

```yaml
resources:
localhost:
attributes:
host.name: localhost
host.type: windows
protocols:
wmi:
timeout: 120
variables:
windowsProcess: # Connector ID
processName: "('msedge.exe', 'metricshub.exe')"
```

#### Discovery cycle

**MetricsHub** periodically performs discoveries to detect new components in your monitored environment. By default, **MetricsHub** runs a discovery after 30 collects. To change this default discovery cycle:
Expand Down

0 comments on commit c5cf9d2

Please sign in to comment.