Use annotations in Chronograf views

Use annotations in the Chronograf interface

Annotations in Chronograf are notes of explanation or comments added to graph views by editors or administrators. Annotations can provide Chronograf users with useful contextual information about single points in time or time intervals. Users can use annotations to correlate the effects of important events, such as system changes or outages across multiple metrics, with Chronograf data.

When an annotation is added, a solid white line appears on all graph views for that point in time or an interval of time.

Annotations example

The following screenshot of five graph views displays annotations for a single point in time and a time interval. The text and timestamp for the single point in time can be seem above the annotation line in the graph view on the lower right. The annotation displays “Deploy v3.8.1-2” and the time “2018/28/02 15:59:30:00”.

Annotations on multiple graph views

To add an annotation using the Chronograf user interface:

  1. Click the Edit button (“pencil” icon) on the graph view.
  2. Click Add Annotation to add an annotation.
  3. Move cursor to point of time and click or drag cursor to set an annotation.
  4. Click Edit again and then click Edit Annotation.
  5. Click the cursor on the annotation point or interval. The annotation text box appears above the annotation point or interval.
  6. Click on Name Me in the annotation and type a note or comment.
  7. Click Done Editing.
  8. Your annotation is now available in all graph views.

Annotations are not associated with specific dashboards and appear in all dashboards. Annotations are managed per InfluxDB data source. When a dashboard is deleted, annotation persist until the InfluxDB data source the annotations are associated with is removed.

Was this page helpful?

Thank you for your feedback!

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: