Skip to content
This repository has been archived by the owner on May 23, 2023. It is now read-only.

Commit

Permalink
Add tag for service (#119)
Browse files Browse the repository at this point in the history
Extend the semantic conventions to include the `service` tag. 

* This tag overrides the default "service name" for a span.
* It is only used when a tracer is reporting spans on behalf of another service.
  • Loading branch information
tylerbenson authored and tedsuo committed Jul 12, 2018
1 parent 1be6305 commit f7ca62c
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 1 deletion.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# History

## 1.2 (2018/05/30)

- Added service tag

## 1.1 (2017/03/19)

- Added message bus tags
Expand Down
3 changes: 2 additions & 1 deletion semantic_conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ Span tags apply to **the entire Span**; as such, they apply to the entire timera
| `peer.ipv4` | string | Remote IPv4 address as a `.`-separated tuple. E.g., `"127.0.0.1"` |
| `peer.ipv6` | string | Remote IPv6 address as a string of colon-separated 4-char hex tuples. E.g., `"2001:0db8:85a3:0000:0000:8a2e:0370:7334"` |
| `peer.port` | integer | Remote port. E.g., `80` |
| `peer.service` | string | Remote service name (for some unspecified definition of `"service"`). E.g., `"elasticsearch"`, `"a_custom_microservice"`, `"memcache"` |
| `peer.service` | string | Remote service name (for some unspecified definition of `"service"`). E.g., `"elasticsearch"`, `"a_custom_microservice"`, `"memcache"`. Meaning should correspond with values set in `service`. |
| `sampling.priority` | integer | If greater than 0, a hint to the Tracer to do its best to capture the trace. If 0, a hint to the trace to not-capture the trace. If absent, the Tracer should use its default sampling mechanism. |
| `service` | string | The service name for a span, which overrides any default "service name" property defined in a tracer's config. The meaning of `service` should correspond to the value set in `peer.service`, except it is applied to the current span. This tag is meant to only be used when a tracer is reporting spans on behalf of another service (for example, a service mesh reporting on behalf of the services it is proxying, or an out-of-band reporter which reads in log files). This tag does not need to be used when reporting spans for the service the tracer is running in. |
| `span.kind` | string | Either `"client"` or `"server"` for the appropriate roles in an RPC, and `"producer"` or `"consumer"` for the appropriate roles in a messaging scenario. |

### Log fields table
Expand Down
1 change: 1 addition & 0 deletions semantic_conventions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ standard_tags:
'peer.port': integer
'peer.service': string
'sampling.priority': integer
'service': string
'span.kind': string

standard_log_fields:
Expand Down

0 comments on commit f7ca62c

Please sign in to comment.