github.com/diptanu/nomad@v0.5.7-0.20170516172507-d72e86cbe3d9/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  ### `statsite`
    62  
    63  These `telemetry` parameters apply to
    64  [statsite](https://github.com/armon/statsite).
    65  
    66  - `statsite_address` `(string: "")` - Specifies the address of a statsite server
    67    to forward metrics data to.
    68  
    69  ```hcl
    70  telemetry {
    71    statsite_address = "statsite.company.local:8125"
    72  }
    73  ```
    74  
    75  ### `statsd`
    76  
    77  These `telemetry` parameters apply to
    78  [statsd](https://github.com/etsy/statsd).
    79  
    80  - `statsd_address` `(string: "")` - Specifies the address of a statsd server to
    81    forward metrics to.
    82  
    83  ```hcl
    84  telemetry {
    85    statsd_address = "statsd.company.local:8125"
    86  }
    87  ```
    88  
    89  ### `datadog`
    90  
    91  These `telemetry` parameters apply to
    92  [DataDog statsd](https://github.com/DataDog/dd-agent).
    93  
    94  - `datadog_address` `(string: "")` - Specifies the address of a DataDog statsd
    95    server to forward metrics to.
    96  
    97  ```hcl
    98  telemetry {
    99    datadog_address = "dogstatsd.company.local:8125"
   100  }
   101  ```
   102  
   103  ### `circonus`
   104  
   105  These `telemetry` parameters apply to
   106  [Circonus](http://circonus.com/).
   107  
   108  - `circonus_api_token` `(string: "")` - Specifies a valid Circonus API Token
   109    used to create/manage check. If provided, metric management is enabled.
   110  
   111  - `circonus_api_app` `(string: "nomad")` - Specifies a valid app name associated
   112    with the API token.
   113  
   114  - `circonus_api_url` `(string: "https://api.circonus.com/v2")` - Specifies the
   115    base URL to use for contacting the Circonus API.
   116  
   117  - `circonus_submission_interval` `(string: "10s")` - Specifies the interval at
   118    which metrics are submitted to Circonus.
   119  
   120  - `circonus_submission_url` `(string: "")` - Specifies the
   121    `check.config.submission_url` field, of a Check API object, from a previously
   122    created HTTPTRAP check.
   123  
   124  - `circonus_check_id` `(string: "")` - Specifies the Check ID (**not check
   125    bundle**) from a previously created HTTPTRAP check. The numeric portion of the
   126    `check._cid` field in the Check API object.
   127  
   128  - `circonus_check_force_metric_activation` `(bool: false)` - Specifies if force
   129    activation of metrics which already exist and are not currently active. If
   130    check management is enabled, the default behavior is to add new metrics as
   131    they are encountered. If the metric already exists in the check, it will
   132    not be activated. This setting overrides that behavior.
   133  
   134  - `circonus_check_instance_id` `(string: "<hostname>:<application>")` - Serves
   135    to uniquely identify the metrics coming from this *instance*.  It can be used
   136    to maintain metric continuity with transient or ephemeral instances as they
   137    move around within an infrastructure. By default, this is set to
   138    hostname:application name (e.g. "host123:nomad").
   139  
   140  - `circonus_check_search_tag` `(string: <service>:<application>)` - Specifies a
   141    special tag which, when coupled with the instance id, helps to narrow down the
   142    search results when neither a Submission URL or Check ID is provided. By
   143    default, this is set to service:app (e.g. "service:nomad").
   144  
   145  - `circonus_check_display_name` `(string: "")` - Specifies a name to give a
   146     check when it is created. This name is displayed in the Circonus UI Checks
   147     list.
   148  
   149  - `circonus_check_tags` `(string: "")` - Comma separated list of additional
   150    tags to add to a check when it is created.
   151  
   152  - `circonus_broker_id` `(string: "")` - Specifies the ID of a specific Circonus
   153    Broker to use when creating a new check. The numeric portion of `broker._cid`
   154    field in a Broker API object. If metric management is enabled and neither a
   155    Submission URL nor Check ID is provided, an attempt will be made to search for
   156    an existing check using Instance ID and Search Tag. If one is not found, a new
   157    HTTPTRAP check will be created. By default, this is a random
   158    Enterprise Broker is selected, or, the default Circonus Public Broker.
   159  
   160  - `circonus_broker_select_tag` `(string: "")` - Specifies a special tag which
   161    will be used to select a Circonus Broker when a Broker ID is not provided. The
   162    best use of this is to as a hint for which broker should be used based on
   163    *where* this particular instance is running (e.g. a specific geo location or
   164    datacenter, dc:sfo).