API Documentation | Metric Cluster
A metric cluster is a cluster of metrics defined by a set of queries.
A string containing a fully qualified metric name in the format <digits>_<string>.
A string containing freeform text
A string containing either 'average', 'count', 'counter', 'counter2', 'counter2_stddev', 'counter_stddev', 'derive', 'derive2', 'derive2_stddev', 'derive_stddev', 'histogram', 'stddev' or 'text'
A tag is just a string, with or without a colon, such as 'foo', 'bar', 'datacenter:london', or 'os:linux'. The part of the string before the colon is considered the category the tag is in; Tag strings without a colon will place the string in the 'uncategorized' category. Circonus will lowercase the contents of the string before storing it.
Fetching Metric Clusters
Fetching details for a metric cluster is as simple as performing a GET on the metric cluster cid:
You'll notice a few important things:
- The metric cluster has both a name and a description, as well as the usual tags
- queries field contains all the queries that define what is contained in the cluster.
Fetching Matching Metrics
It's possible to use the API to get a list of what the current matching
metrics are by passing the
extra=_matching_metrics query parameter:
You can also get the same matching metric list categorized by check_uuid by passing:
extra=_matching_uuid_metrics query parameter:
Creating a Metric Cluster
Creating a new metrics cluster is as simple as making a HTTP POST request to
/metric_cluster and passing JSON representing the new metric
Updating a Metric Cluster
Metric clusters can be updated simply by using the PUT HTTP method with new field values:
As is normal with Circonus the PUT method returns the full JSON of the updated metric cluster in response.
Altering the queries for the metric cluster can be updated the same way, by simply altering the queries list to contain the new queries you want and passing it, along with the other values, during a HTTP PUT to the original cid.
The API intelligently examines the new field values and automatically adds and removes queries as needed.
Listing and Searching Metric Clusters
Metric clusters can be listed simply by performing a HTTP GET request on
/metric_cluster. You can search in the usual way, for
example to list all clusters with the word "All" in the name:
Or all the clusters with the
Removing Metric Clusters
Metric clusters can be simply removed by using the DELETE HTTP method on the cid:
Circonus Keyboard Shortcuts
- Jump to the user documentation.
- Show this keyboard help screen.
- Close help screens and dialogs.
- Focus on any available search field.
- Refresh content on the page without reloading the entire page; currently works on graphs, worksheets, and dashboards.
Graph Grid Shortcuts
- On a worksheet, hold it down to invert the current legend hover
On “My Graphs” and the “Trending & Analytics Dash,” hold it down to show the legend when hovering over a graph.
- Hold down to show the date shifting toolbar for modifying the start date. Can be combined with <period>.
- Hold down to show the date shifting toolbar for modifying the end date. Can be combined with <comma>.
- Nudge the date range for the current graph(s) backward.
- Nudge the date range for the current graph(s) forward.
- Toggle the display of histogram sparklines (shown upon hovering over a graph when viewing or when on a dashboard).
- Hold down to unlock graph hovering datapoint selection, allowing mouse hovering to select nearby datapoints.
Mousewheel & Touchpad Shortcuts
- Hold down while scrolling to zoom graphs' Y axes.
- Hold down while scrolling to zoom graphs' X axis.
- Hold down while scrolling to shift graphs' X axis.
- Hold down while scrolling to shift graphs' X axis start dates. Can be combined with <period>.
- Hold down while scrolling to shift graphs' X axis end dates. Can be combined with <comma>.