This document will explain how to add attributes to trace data sent to the MegaEase Cloud so that spans display specific properties in the UI.
When you send data to our MegaEase Cloud, you can add custom attributes to spans. For example, you might decide to add tags like order.id or user.id in order to help you analyze your trace data.
Some expected attribute values cause our distributed tracing UI to display some specific trace properties and details.
For example, if a span has a tag with an error, the UI displays that span with an error.
For another example, a span with a tag that has a component.type=database will be displayed as a datastore span in the UI.
Decorating your spans to show specific properties in our UI can help you:
- Better understand the structure of your trace data.
- More easily troubleshoot problems.
This table explains how to get spans sent to the MegaEase Cloud to show up with specific Middleware in the UI.
Use a tag with a key component.type，Different types represent different Middleware. The following is a list of special middleware for MegaEase Cloud.
| Middleware | value |
|---|---|
| MySql | database |
| Redis | redis |
| ElasticSearch | elasticsearch |
| Kafka | kafka |
| RabbitMQ | rabbitmq |
| MongoDB | mongodb |
| Motan | motan |
Use a remote ServiceName with an {type}-{name} prefix. When no name, just type. The following is a list of special middleware remote ServiceName for MegaEase Cloud.
| Middleware | value |
|---|---|
| MySql | mysql-{db_name} |
| Redis | redis |
| ElasticSearch | elasticsearch |
| Kafka | kafka |
| RabbitMQ | rabbitmq |
| MongoDB | mongodb-{db_name} |
| Motan | motan |
The following tags are commonly used conventional tags in 'MegaEase Cloud'.
| Tag | description |
|---|---|
| component.type | middleware type, final value: database |
| sql | query mysql sql |
| url | database connect url |
| Tag | description |
|---|---|
| component.type | middleware type, final value: redis |
| redis.method | the redis cmd |
| Tag | description |
|---|---|
| component.type | middleware type, final value: elasticsearch |
| es.index | the es index |
| es.operation | the request HTTP Method and Endpoint |
| es.body | the es request entity body |
| Tag | description |
|---|---|
| component.type | middleware type, final value: kafka |
| kafka.topic | kafka producer or consumer topic |
| kafka.key | kafka producer or consumer key |
| kafka.broker | kafka producer or consumer broker uri |
| Tag | description |
|---|---|
| component.type | middleware type, final value: rabbitmq |
| rabbit.exchange | redis request name of the exchange |
| rabbit.routing_key | redis received routing key |
| rabbit.queue | redis request name of queue |
| rabbit.broker | redis request broker uri |
| Tag | description |
|---|---|
| component.type | middleware type, final value: mongodb |
| mongodb.command | mongodb request command |
| mongodb.collection | mongodb requst collection |
| mongodb.cluster_id | mongodb requst cluster_id |