Documentation for automated readers
A curated documentation index is available at: https://grafana.com/llms.txt
A complete documentation index is available at: https://grafana.com/llms-full.txt
These indexes can help with page discovery before fetching individual documents.
This page is also available in Markdown, which may be easier for automated readers and AI tools to parse than HTML. The Markdown version is available at https://grafana.com/docs/grafana-cloud/monitor-applications/application-observability/manual/annotations.md, or by sending Accept: text/markdown to https://grafana.com/docs/grafana-cloud/monitor-applications/application-observability/manual/annotations/. For broader documentation discovery, the curated index is available at https://grafana.com/llms.txt and the complete index is available at https://grafana.com/llms-full.txt.
Application Observability service overview annotations
You can enable Application Observability to display annotations in the service overview duration panel.
Note
When you create annotations, they display only for the specific service that you designate.
Create annotations
You must define the following tags to view annotations correctly:
service.name=name-of-service: The service overview always adds the service name to the queryservice.namespace=my-namespace: If the service has a namespace, you must also add this tagdeployment.environment=name-of-environment: If you selected an environment value in the service overview, you must also add the configured environment attribute. For example,deployment.environment=oteldemo01. If you have customized the name of the environment semantic attribute on the Settings tab of the Configuration page, then you should use that name instead. For example,deployment.environment.name=oteldemo01.
The following example shows how to create service view annotations:
POST /api/annotations HTTP/1.1
Accept: application/json
Content-Type: application/json
{
"time":1507037197339,
"timeEnd":0,
"tags":["service.name=cartservice","service.namespace=oteldemo01"],
"text":"Annotation Description"
}Enable or disable service overview annotations
You can enable or disable annotations from the Settings tab on the Configuration page under the Service overview annotations section.
Was this page helpful?
Related resources from Grafana Labs


