github.com/danp/terraform@v0.9.5-0.20170426144147-39d740081351/website/source/docs/providers/circonus/d/collector.html.markdown (about)

     1  ---
     2  layout: "circonus"
     3  page_title: "Circonus: collector"
     4  sidebar_current: "docs-circonus-datasource-collector"
     5  description: |-
     6      Provides details about a specific Circonus Collector.
     7  ---
     8  
     9  # circonus_collector
    10  
    11  `circonus_collector` provides
    12  [details](https://login.circonus.com/resources/api/calls/broker) about a specific
    13  [Circonus Collector](https://login.circonus.com/user/docs/Administration/Brokers).
    14  
    15  As well as validating a given Circonus ID, this resource can be used to discover
    16  the additional details about a collector configured within the provider.  The
    17  results of a `circonus_collector` API call can return more than one collector
    18  per Circonus ID.  Details of each individual collector in the group of
    19  collectors can be found via the `details` attribute described below.
    20  
    21  ~> **NOTE regarding `cirocnus_collector`:** The `circonus_collector` data source
    22  actually queries and operates on Circonus "brokers" at the broker group level.
    23  The `circonus_collector` is simply a renamed Circonus "broker" to make it clear
    24  what the function of the "broker" actually does: act as a fan-in agent that
    25  either pulls or has metrics pushed into it and funneled back through Circonus.
    26  
    27  ## Example Usage
    28  
    29  The following example shows how the resource might be used to obtain
    30  the name of the Circonus Collector configured on the provider.
    31  
    32  ```hcl
    33  data "circonus_collector" "ashburn" {
    34    id = "/broker/1"
    35  }
    36  ```
    37  
    38  ## Argument Reference
    39  
    40  The arguments of this data source act as filters for querying the available
    41  regions. The given filters must match exactly one region whose data will be
    42  exported as attributes.
    43  
    44  * `id` - (Optional) The Circonus ID of a given collector.
    45  
    46  At least one of the above attributes should be provided when searching for a
    47  collector.
    48  
    49  ## Attributes Reference
    50  
    51  The following attributes are exported:
    52  
    53  * `id` - The Circonus ID of the selected Collector.
    54  
    55  * `details` - A list of details about the individual Collector instances that
    56    make up the group of collectors.  See below for a list of attributes within
    57    each collector.
    58  
    59  * `latitude` - The latitude of the selected Collector.
    60  
    61  * `longitude` - The longitude of the selected Collector.
    62  
    63  * `name` - The name of the selected Collector.
    64  
    65  * `tags` - A list of tags assigned to the selected Collector.
    66  
    67  * `type` - The of the selected Collector.  This value is either `circonus` for a
    68    Circonus-managed, public Collector, or `enterprise` for a private collector that is
    69    private to an account.
    70  
    71  ## Collector Details
    72  
    73  * `cn` - The CN of an individual Collector in the Collector Group.
    74  
    75  * `external_host` - The external host information for an individual Collector in
    76    the Collector Group.  This is useful or important when talking with a Collector
    77    through a NAT'ing firewall.
    78  
    79  * `external_port` - The external port number for an individual Collector in the
    80    Collector Group.  This is useful or important when talking with a Collector through
    81    a NAT'ing firewall.
    82  
    83  * `ip` - The IP address of an individual Collector in the Collector Group.  This is
    84    the IP address of the interface listening on the network.
    85  
    86  * `min_version` - ??
    87  
    88  * `modules` - A list of what modules (types of checks) this collector supports.
    89  
    90  * `port` - The port the collector responds to the Circonus HTTPS REST wire protocol
    91    on.
    92  
    93  * `skew` - The clock drift between this collector and the Circonus server.
    94  
    95  * `status` - The status of this particular collector. A string containing either
    96    `active`, `unprovisioned`, `pending`, `provisioned`, or `retired`.
    97  
    98  * `version` - The version of the collector software the collector is running.