github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/tools/autoscaling/agent/telemetry.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: telemetry Stanza - Nomad Autoscaler Agent Configuration
     4  description: >-
     5    The "telemetry" block configures the Nomad Autoscaler's publication of metrics
     6    and telemetry to third-party systems.
     7  ---
     8  
     9  # `telemetry` Block
    10  
    11  <Placement groups={['telemetry']} />
    12  
    13  The `telemetry` block configures the Nomad Autoscaler's publication of metrics
    14  and telemetry to third-party systems.
    15  
    16  ```hcl
    17  telemetry {
    18    disable_hostname = true
    19  }
    20  ```
    21  
    22  ## `telemetry` Parameters
    23  
    24  Due to the number of provider-specific parameters to the `telemetry` block, parameters
    25  in this section are grouped by the telemetry provider.
    26  
    27  ### Common Parameters
    28  
    29  The following options are available on all telemetry configurations.
    30  
    31  - `disable_hostname` `(bool: false)` - Specifies if gauge values should be
    32    prefixed with the local hostname.
    33  
    34  - `enable_hostname_label` `(bool: false)` - Enable adding hostname to metric
    35    labels.
    36  
    37  - `collection_interval` `(duration: "1s")` - Specifies the time interval at which
    38    the Nomad agent collects telemetry data.
    39  
    40  ### `statsite` Parameters
    41  
    42  These `telemetry` parameters apply to [Statsite][statsite].
    43  
    44  - `statsite_address` `(string: "")` - Specifies the address of a statsite server
    45    to forward metrics data to.
    46  
    47  ```hcl
    48  telemetry {
    49    statsite_address = "statsite.company.local:8125"
    50  }
    51  ```
    52  
    53  ### `statsd` Parameters
    54  
    55  These `telemetry` parameters apply to [StatsD][statsd].
    56  
    57  - `statsd_address` `(string: "")` - Specifies the address of a statsd server to
    58    forward metrics to.
    59  
    60  ```hcl
    61  telemetry {
    62    statsd_address = "statsd.company.local:8125"
    63  }
    64  ```
    65  
    66  ### `datadog` Parameters
    67  
    68  These `telemetry` parameters apply to [DataDog statsd][datadog_statsd].
    69  
    70  - `dogstatsd_address` `(string: "")` - Specifies the address of a DataDog statsd
    71    server to forward metrics to.
    72  
    73  - `dogstatsd_tags` `(list: [])` - Specifies a list of global tags that will be
    74    added to all telemetry packets sent to DogStatsD. It is a list of strings,
    75    where each string looks like `my_tag_name:my_tag_value`.
    76  
    77  ```hcl
    78  telemetry {
    79    dogstatsd_address = "dogstatsd.company.local:8125"
    80    dogstatsd_tags    = ["my_tag_name:my_tag_value"]
    81  }
    82  ```
    83  
    84  ### `prometheus` Parameters
    85  
    86  These `telemetry` parameters apply to [Prometheus][prometheus].
    87  
    88  - `prometheus_metrics` `(bool: false)` - Specifies whether the agent should
    89    make Prometheus formatted metrics available at `/v1/metrics?format=prometheus`.
    90  
    91  - `prometheus_retention_time` `(string: "24h")` - Specifies the amount of time that Prometheus
    92    metrics are retained in memory.
    93  
    94  ### `circonus` Parameters
    95  
    96  These `telemetry` parameters apply to [Circonus][circonus].
    97  
    98  - `circonus_api_token` `(string: "")` - Specifies a valid Circonus API Token
    99    used to create/manage check. If provided, metric management is enabled.
   100  
   101  - `circonus_api_app` `(string: "nomad-autoscaler")` - Specifies a valid app name
   102    associated with the API token.
   103  
   104  - `circonus_api_url` `(string: "https://api.circonus.com/v2")` - Specifies the
   105    base URL to use for contacting the Circonus API.
   106  
   107  - `circonus_submission_interval` `(string: "10s")` - Specifies the interval at
   108    which metrics are submitted to Circonus.
   109  
   110  - `circonus_submission_url` `(string: "")` - Specifies the
   111    `check.config.submission_url` field, of a Check API object, from a previously
   112    created HTTPTRAP check.
   113  
   114  - `circonus_check_id` `(string: "")` - Specifies the Check ID (**not check
   115    bundle**) from a previously created HTTPTrap check. The numeric portion of the
   116    `check._cid` field in the Check API object.
   117  
   118  - `circonus_check_force_metric_activation` `(bool: false)` - Specifies if force
   119    activation of metrics which already exist and are not currently active. If
   120    check management is enabled, the default behavior is to add new metrics as
   121    they are encountered. If the metric already exists in the check, it will
   122    not be activated. This setting overrides that behavior.
   123  
   124  - `circonus_check_instance_id` `(string: "<hostname>:<application>")` - Serves
   125    to uniquely identify the metrics coming from this _instance_. It can be used
   126    to maintain metric continuity with transient or ephemeral instances as they
   127    move around within an infrastructure. By default, this is set to
   128    "hostname:application name" (e.g. `host123:nomad-autoscaler`).
   129  
   130  - `circonus_check_search_tag` `(string: <service>:<application>)` - Specifies a
   131    special tag which, when coupled with the instance id, helps to narrow down the
   132    search results when neither a Submission URL or Check ID is provided. By
   133    default, this is set to "service:app" (e.g. `service:nomad-autoscaler`).
   134  
   135  - `circonus_check_display_name` `(string: "")` - Specifies a name to give a
   136    check when it is created. This name is displayed in the Circonus UI Checks
   137    list.
   138  
   139  - `circonus_check_tags` `(string: "")` - Comma separated list of additional
   140    tags to add to a check when it is created.
   141  
   142  - `circonus_broker_id` `(string: "")` - Specifies the ID of a specific Circonus
   143    Broker to use when creating a new check. The numeric portion of `broker._cid`
   144    field in a Broker API object. If metric management is enabled and neither a
   145    Submission URL nor Check ID is provided, an attempt will be made to search for
   146    an existing check using Instance ID and Search Tag. If one is not found, a new
   147    HTTPTrap check will be created. By default, this is a random
   148    Enterprise Broker is selected, or, the default Circonus Public Broker.
   149  
   150  - `circonus_broker_select_tag` `(string: "")` - Specifies a special tag which
   151    will be used to select a Circonus Broker when a Broker ID is not provided. The
   152    best use of this is to as a hint for which broker should be used based on
   153    _where_ this particular instance is running (e.g., a specific geographic location or
   154    datacenter, dc:sfo).
   155  
   156  [statsite]: https://github.com/armon/statsite
   157  [statsd]: https://github.com/etsy/statsd
   158  [datadog_statsd]: https://github.com/DataDog/datadog-agent
   159  [prometheus]: https://prometheus.io
   160  [circonus]: http://circonus.com/