github.com/blixtra/nomad@v0.7.2-0.20171221000451-da9a1d7bb050/website/source/docs/agent/configuration/telemetry.html.md (about)

     1  ---
     2  layout: "docs"
     3  page_title: "telemetry Stanza - Agent Configuration"
     4  sidebar_current: "docs-agent-configuration-telemetry"
     5  description: |-
     6    The "telemetry" stanza configures Nomad's publication of metrics and telemetry
     7    to third-party systems.
     8  ---
     9  
    10  # `telemetry` Stanza
    11  
    12  <table class="table table-bordered table-striped">
    13    <tr>
    14      <th width="120">Placement</th>
    15      <td>
    16        <code>**telemetry**</code>
    17      </td>
    18    </tr>
    19  </table>
    20  
    21  
    22  The `telemetry` stanza configures Nomad's publication of metrics and telemetry
    23  to third-party systems.
    24  
    25  ```hcl
    26  telemetry {
    27    publish_allocation_metrics = true
    28    publish_node_metrics       = true
    29  }
    30  ```
    31  
    32  This section of the documentation only covers the configuration options for
    33  `telemetry` stanza. To understand the architecture and metrics themselves,
    34  please see the [Nomad telemetry documentation](/docs/agent/telemetry.html).
    35  
    36  ## `telemetry` Parameters
    37  
    38  Due to the number of configurable parameters to the `telemetry` stanza,
    39  parameters on this page are grouped by the telemetry provider.
    40  
    41  ### Common
    42  
    43  The following options are available on all telemetry configurations.
    44  
    45  - `disable_hostname` `(bool: false)` - Specifies if gauge values should be
    46    prefixed with the local hostname.
    47  
    48  - `collection_interval` `(duration: 1s)` - Specifies the time interval at which
    49    the Nomad agent collects telemetry data.
    50  
    51  - `use_node_name` `(bool: false)` - Specifies if gauge values should be
    52    prefixed with the name of the node, instead of the hostname. If set it will
    53    override [disable_hostname](#disable_hostname) value.
    54  
    55  - `publish_allocation_metrics` `(bool: false)` - Specifies if Nomad should
    56    publish runtime metrics of allocations.
    57  
    58  - `publish_node_metrics` `(bool: false)` - Specifies if Nomad should publish
    59    runtime metrics of nodes.
    60  
    61  - `backwards_compatible_metrics` `(bool: false)` - Specifies if Nomad should
    62    publish metrics that are backwards compatible with versions below 0.7, as
    63    post version 0.7, Nomad emits tagged metrics. All new metrics will
    64    only be added to tagged metrics. Note that this option is used to transition
    65    monitoring to tagged metrics and will eventually be deprecated.
    66  
    67  
    68  - `disable_tagged_metrics` `(bool: false)` - Specifies if Nomad should not emit
    69    tagged metrics and only emit metrics compatible with versions below Nomad
    70    0.7. Note that this option is used to transition monitoring to tagged
    71    metrics and will eventually be deprecated.
    72  
    73  
    74  
    75  ### `statsite`
    76  
    77  These `telemetry` parameters apply to
    78  [statsite](https://github.com/armon/statsite).
    79  
    80  - `statsite_address` `(string: "")` - Specifies the address of a statsite server
    81    to forward metrics data to.
    82  
    83  ```hcl
    84  telemetry {
    85    statsite_address = "statsite.company.local:8125"
    86  }
    87  ```
    88  
    89  ### `statsd`
    90  
    91  These `telemetry` parameters apply to
    92  [statsd](https://github.com/etsy/statsd).
    93  
    94  - `statsd_address` `(string: "")` - Specifies the address of a statsd server to
    95    forward metrics to.
    96  
    97  ```hcl
    98  telemetry {
    99    statsd_address = "statsd.company.local:8125"
   100  }
   101  ```
   102  
   103  ### `datadog`
   104  
   105  These `telemetry` parameters apply to
   106  [DataDog statsd](https://github.com/DataDog/dd-agent).
   107  
   108  - `datadog_address` `(string: "")` - Specifies the address of a DataDog statsd
   109    server to forward metrics to.
   110  
   111  ```hcl
   112  telemetry {
   113    datadog_address = "dogstatsd.company.local:8125"
   114  }
   115  ```
   116  
   117  ### `prometheus`
   118  
   119  These `telemetry` parameters apply to [Prometheus](https://prometheus.io).
   120  
   121  - `prometheus_metrics` `(bool: false)` - Specifies whether the agent should
   122    make Prometheus formatted metrics available at `/v1/metrics?format=prometheus`.
   123  
   124  ### `circonus`
   125  
   126  These `telemetry` parameters apply to
   127  [Circonus](http://circonus.com/).
   128  
   129  - `circonus_api_token` `(string: "")` - Specifies a valid Circonus API Token
   130    used to create/manage check. If provided, metric management is enabled.
   131  
   132  - `circonus_api_app` `(string: "nomad")` - Specifies a valid app name associated
   133    with the API token.
   134  
   135  - `circonus_api_url` `(string: "https://api.circonus.com/v2")` - Specifies the
   136    base URL to use for contacting the Circonus API.
   137  
   138  - `circonus_submission_interval` `(string: "10s")` - Specifies the interval at
   139    which metrics are submitted to Circonus.
   140  
   141  - `circonus_submission_url` `(string: "")` - Specifies the
   142    `check.config.submission_url` field, of a Check API object, from a previously
   143    created HTTPTRAP check.
   144  
   145  - `circonus_check_id` `(string: "")` - Specifies the Check ID (**not check
   146    bundle**) from a previously created HTTPTRAP check. The numeric portion of the
   147    `check._cid` field in the Check API object.
   148  
   149  - `circonus_check_force_metric_activation` `(bool: false)` - Specifies if force
   150    activation of metrics which already exist and are not currently active. If
   151    check management is enabled, the default behavior is to add new metrics as
   152    they are encountered. If the metric already exists in the check, it will
   153    not be activated. This setting overrides that behavior.
   154  
   155  - `circonus_check_instance_id` `(string: "<hostname>:<application>")` - Serves
   156    to uniquely identify the metrics coming from this *instance*.  It can be used
   157    to maintain metric continuity with transient or ephemeral instances as they
   158    move around within an infrastructure. By default, this is set to
   159    hostname:application name (e.g. "host123:nomad").
   160  
   161  - `circonus_check_search_tag` `(string: <service>:<application>)` - Specifies a
   162    special tag which, when coupled with the instance id, helps to narrow down the
   163    search results when neither a Submission URL or Check ID is provided. By
   164    default, this is set to service:app (e.g. "service:nomad").
   165  
   166  - `circonus_check_display_name` `(string: "")` - Specifies a name to give a
   167     check when it is created. This name is displayed in the Circonus UI Checks
   168     list.
   169  
   170  - `circonus_check_tags` `(string: "")` - Comma separated list of additional
   171    tags to add to a check when it is created.
   172  
   173  - `circonus_broker_id` `(string: "")` - Specifies the ID of a specific Circonus
   174    Broker to use when creating a new check. The numeric portion of `broker._cid`
   175    field in a Broker API object. If metric management is enabled and neither a
   176    Submission URL nor Check ID is provided, an attempt will be made to search for
   177    an existing check using Instance ID and Search Tag. If one is not found, a new
   178    HTTPTRAP check will be created. By default, this is a random
   179    Enterprise Broker is selected, or, the default Circonus Public Broker.
   180  
   181  - `circonus_broker_select_tag` `(string: "")` - Specifies a special tag which
   182    will be used to select a Circonus Broker when a Broker ID is not provided. The
   183    best use of this is to as a hint for which broker should be used based on
   184    *where* this particular instance is running (e.g. a specific geographic location or
   185    datacenter, dc:sfo).