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