Hosted Graphite Docs
Get StartedBook a Demo
  • Welcome to Hosted Graphite
  • Getting Started
  • HG-CLI
  • Sending Metrics
    • Supported Protocols
    • Graphite Tag Support
    • Metric Management
    • Metric APIs
  • Language Guide
    • Metric Libraries
    • .NET
    • Go
    • Java
    • Javascript
    • Node.js
    • PHP
    • Postman
    • Python 2.x
    • Python 3.x
    • Python Pickle
    • Ruby
    • Shell
    • TypeScript
  • Dashboard and Graphs
    • Primary Dashboards
    • Dashboard Library
    • Local Dashboard Integration
    • Worldmap Panel
    • Graphite Dashboard Guide
    • Graphite Graph Menu Reference
    • Other Dashboard Options
  • Alerting Guide
    • Alerting Overview
    • Alerts API
    • Notification Channels API
    • Scheduled Mutes API
    • Using Your Own Alerting
  • Agents Guide
    • The Hosted Graphite Agent
      • Base Metrics
      • System Layout
    • Telegraf
    • K8 Telegraf Daemon
    • OpenTelemetry
    • collectd Agent
    • StatsD Agent
    • Diamond
  • Add-Ons and Integrations Guide
    • AWS CloudWatch
    • Azure Monitor Metrics
    • GCP Metrics
    • Carbon-C-Relay
    • Circle CI
    • Cloudbees
    • Collectd Add Ons
    • GitHub
    • GitLab
    • Heroku
    • Hosted StatsD
    • New Relic
    • Papertrail
    • Pingdom
    • Sentry
    • Sitespeed
    • StatsD Add-on
    • Statuspage
  • Account Management
    • Access Keys
    • Account Diagnostics
    • Account Settings
    • Team Access: Limited Access Groups
    • SAML Authentication
    • Team Access
  • Additional Features
    • Aggregation Rules
    • Data Views
  • API Guides
    • Metrics API
    • Tag API
    • Graphite Render API
    • Render Variables API
    • Dashboard API
    • Annotations and Events API
    • Aggregation Rules API
    • Alerts APIs
  • FAQ
    • General
    • Business
    • Technical
    • Account Metrics and Limiting
    • Customization
    • Troubleshooting
    • Support
    • Changelog
Powered by GitBook
On this page
  • What are Graphite Tags?
  • Why use Graphite Tags?
  • Sending Tagged Metrics
  • Graphing and Alerting on Tagged Metrics
  • Managing Tagged Metrics
  • Tag API

Was this helpful?

  1. Sending Metrics

Graphite Tag Support

PreviousSupported ProtocolsNextMetric Management

Last updated 6 months ago

Was this helpful?

With the release of the 1.1.x series, Graphite now supports .

Rather than using the traditional dotted hierarchy, metrics can be stored and retrieved based on tags - for example, host=webserver- or region=us-east-1.

So where before you might have a name like myapp.webserver-0001.us-east-1.responses.500, you could instead have myapp.responses;host=webserver-0001;region=us-east-1;code=500

It’s becoming common in monitoring systems to use a tagged (or labeled) metric format. This allows for more flexibility both in naming and retrieving metrics. Tags also allow you to categorize metrics based on various dimensions or attributes enabling you to filter and aggregate data in ways that make sense for your analysis.

Note that when using tags, each metric is uniquely identified by its name and set of tag/value pairs. As a result, an existing tagged metric cannot be updated to contain new tags.

For example, let’s count 500 responses for My App in both formats:

Dotted Format

myapp.*.*.responses.500
  • Order matters

  • Can have many node options which can be unwieldy

Tag Format

seriesByTag("path=myapp.responses","code=500")
  • Order does not matter

  • You do not always need every node in the metric name to locate one metric or series

  • Does not support wildcards, but accepts regular expressions

The latter allows us to quickly slice and dice metrics by their tags that you get to specify when creating the metric. We don’t have to remember what’s in each position in the dotted hierarchy, and the tags make the query “self documenting”.

Tags are particularly useful in modern cloud environments, where e.g. host or instance may change often, while the total number of metrics being stored and queried remains fairly constant.

You can use the same Carbon endpoints you already use to send tagged metrics. All you need to do is include the tags and values in the updated Carbon line protocol format (unix timestamp is optional):

my.series;tag1=value1;tag2=value2 metric_value (timestamp)
echo "YOUR-API-KEY.foo.bar;tag1=value1;tag2=value2 1.2" | nc carbon.hostedgraphite.com 2003

You can query metrics by their tag values, or by the metric name but all queries must be wrapped with a seriesByTag() graphite function. You can do this in your dashboards by toggling the query box to free-text-mode and typing out the full query. Or you could begin by adding the seriesByTag() function and filling the boxes with your search terms using the expressions (see table below) where necessary.

You can also search for tagged metrics in the HG Tag Search UI, and use the Explore feature to open dashboard panels with pre-formatted queries.

You can use any number of tag expressions to filter through your metrics:

seriesByTag("name=myapp.response")
seriesByTag("name=myapp.response","code=200")
seriesByTag("name=myapp.response","code=200","env=production")

Other graphite functions also work, such as sumSeries in the below example:

sumSeries(seriesByTag("name=myapp.response","code=200","env=production"))
sumSeries(seriesByTag("name=myapp.response","code!=200","env=production"))

seriesByTag() supports any number of tag expressions to refine the results. If using multiple expressions, only series that match all of them will be returned. Expressions have the following formats:

tag!=spec

tag value does not exactly match the spec

tag=~spec

tag value matches the regular expression spec

tag!=~spec

tag value does not match the regular expression spec

tag=spec

tag value exactly matches the spec

Example:

Find all series where server matches the regular expression 0\.* and env is not staging

seriesByTag("server=~0\.*","env!=staging")

These are the ‘tagged’ equivalent of the aliasByNodes() and groupByNodes() Graphite functions.

aliasByTags requires at least one tag name to be passed in, below we have three:

aliasByTags(seriesByTag("server=~0\.*","env!=staging"),"env","server","code")

groupByTags requires an aggregation method to be passed in (e.g. min, max, avg, sum, etc.), below we use sum:

groupByTags(seriesByTag("server=~0\.*", "env!=staging"),"sum","code")

You can easily locate and delete your tagged metrics from within our Tag Search feature. Just select a tag name, search for a value, and a list of matching metrics will be rendered with the option to view or delete any selected metrics.

We also offer a Tag Expiry feature that will automatically delete tagged metrics after a defined period of inactivity:

E.g. to get started quickly you can use the utility as follows:

Sending metrics in your favorite language is similar. Refer to .

For a full list of Graphite functions and how to use them, check out the .

For more information about querying tagged metrics refer to the

Check out our tag API documentation .

netcat
our language guide
Graphite Function Docs
Graphite Tag Docs
here
tagged metrics
Graphite Tag Support
What are Graphite Tags?
Why use Graphite Tags?
Sending Tagged Metrics
Graphing and Alerting on Tagged Metrics
seriesByTag()
aliasByTags() and groupByTags()
Managing Tagged Metrics
Tag API
What are Graphite Tags?
Why use Graphite Tags?
Sending Tagged Metrics
Graphing and Alerting on Tagged Metrics
seriesByTag()
aliasByTags() and groupByTags()
Managing Tagged Metrics
Tag API
Tagged Metric Alert
Tag Search UI
Tagged Metric Expiry