AWS X-Ray Tracer Configuration¶

Configuration for AWS X-Ray tracer

config.trace.v3.XRayConfig¶

[config.trace.v3.XRayConfig proto]

{
  "daemon_endpoint": "{...}",
  "segment_name": "...",
  "sampling_rule_manifest": "{...}",
  "segment_fields": "{...}"
}

daemon_endpoint: (config.core.v3.SocketAddress) The UDP endpoint of the X-Ray Daemon where the spans will be sent. If this value is not set, the default value of 127.0.0.1:2000 will be used.

segment_name: (string, REQUIRED) The name of the X-Ray segment.

sampling_rule_manifest: (config.core.v3.DataSource) The location of a local custom sampling rules JSON file. For an example of the sampling rules see: X-Ray SDK documentation

segment_fields: (config.trace.v3.XRayConfig.SegmentFields) Optional custom fields to be added to each trace segment. see: X-Ray Segment Document documentation

config.trace.v3.XRayConfig.SegmentFields¶

[config.trace.v3.XRayConfig.SegmentFields proto]

{
  "origin": "...",
  "aws": "{...}"
}

origin: (string) The type of AWS resource, e.g. “AWS::AppMesh::Proxy”.

aws: (Struct) AWS resource metadata dictionary. See: X-Ray Segment Document documentation