This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Create or update annotation
editCreate or update annotation
editPOST /api/apm/services/:serviceName/annotation
-
service -
(required, object) Service identifying the configuration to create or update.
Properties of
service-
version - (required, string) Version of service.
-
environment - (optional, string) Environment of service.
-
-
@timestamp - (required, string) The date and time of the annotation. Must be in ISO 8601 format.
-
message -
(optional, string) The message displayed in the annotation. Defaults to
service.version. -
tags -
(optional, array) Tags are used by the APM UI to distinguish APM annotations from other annotations.
Tags may have additional functionality in future releases. Defaults to
[apm]. While you can add additional tags, you cannot remove theapmtag.
The following example creates an annotation for a service named opbeans-java.
curl -X POST \
http://localhost:5601/api/apm/services/opbeans-java/annotation \
-H 'Content-Type: application/json' \
-H 'kbn-xsrf: true' \
-H 'Authorization: Basic YhUlubWZhM0FDbnlQeE6WRtaW49FQmSGZ4RUWXdX' \
-d '{
"@timestamp": "2020-05-08T10:31:30.452Z",
"service": {
"version": "1.2"
},
"message": "Deployment 1.2"
}'
{
"_index": "observability-annotations",
"_id": "Lc9I93EBh6DbmkeV7nFX",
"_version": 1,
"_seq_no": 12,
"_primary_term": 1,
"found": true,
"_source": {
"message": "Deployment 1.2",
"@timestamp": "2020-05-08T10:31:30.452Z",
"service": {
"version": "1.2",
"name": "opbeans-java"
},
"tags": [
"apm",
"elastic.co",
"customer"
],
"annotation": {
"type": "deployment"
},
"event": {
"created": "2020-05-09T02:34:43.937Z"
}
}
}