Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

tracing: xray annotation documentation and CODEOWNER #35257

Merged
merged 5 commits into from
Jul 24, 2024
Merged

tracing: xray annotation documentation and CODEOWNER #35257

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
64e6a45
xray trace documentation and CODEOWNER
nbaws Jul 18, 2024
7222d8c
Update api/envoy/config/trace/v3/xray.proto
nbaws Jul 19, 2024
c545f71
Merge branch 'envoyproxy:main' into xray_annotations
nbaws Jul 23, 2024
2268faf
Merge branch 'envoyproxy:main' into xray_annotations
nbaws Jul 24, 2024
9904568
add whitespace for doc build failure
nbaws Jul 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CODEOWNERS
View file
Open in desktop
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ extensions/filters/common/original_src @klarose @mattklein123
# tracers.datadog extension
/*/extensions/tracers/datadog @dmehala @mattklein123
# tracers.xray extension
/*/extensions/tracers/xray @suniltheta @mattklein123
/*/extensions/tracers/xray @suniltheta @mattklein123 @nbaws
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @suniltheta to approve

# tracers.skywalking extension
/*/extensions/tracers/skywalking @wbpcode @Shikugawa
# tracers.opentelemetry extension
Expand Down
58 changes: 57 additions & 1 deletion api/envoy/config/trace/v3/xray.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,63 @@ option (udpa.annotations.file_status).package_version_status = ACTIVE;

// [#protodoc-title: AWS X-Ray Tracer Configuration]
// Configuration for AWS X-Ray tracer

// The X-Ray tracer will automatically attach :ref:`custom_tags <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.custom_tags>` as annotations to the span.
// See: `Annotations https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-annotations`
nbaws marked this conversation as resolved.
Show resolved Hide resolved
// AWS X-Ray trace annotations are also created by the tracing subsystem automatically based on metadata provided during creation of a span.
// An example X-Ray trace span that is generated by the envoy trace subsystem is as follows:
//
// .. code-block:: json
//
// {
// "Id": "1-6698980d-e829ae270ab34b69b488b098",
// "Duration": 0.016,
// "LimitExceeded": false,
// "Segments":
// [
// {
// "Id": "15d65e5ced8dfe76",
// "Document":
// {
// "id": "15d65e5ced8dfe76",
// "name": "envoy-example",
// "start_time": 1721276429.410355,
// "trace_id": "1-6698980d-e829ae270ab34b69b488b098",
// "end_time": 1721276429.426068,
// "fault": true,
// "http":
// {
// "request":
// {
// "url": "http://example/path",
// "method": "GET",
// "user_agent": "curl/8.5.0",
// "client_ip": "127.0.0.1",
// "x_forwarded_for": false
// },
// "response":
// {
// "status": 503,
// "content_length": 216
// }
// },
// "aws": {},
// "annotations":
// {
// "response_flags": "UF",
// "component": "proxy",
// "upstream_cluster": "upstream_cluster",
// "annotation_from_custom_tag": "example",
// "http.protocol": "HTTP/1.1",
// "request_size": "0",
// "downstream_cluster": "-",
// "direction": "ingress",
// "upstream_cluster.name": "upstream_cluster"
// }
// }
// }
// ]
// }
//
// [#extension: envoy.tracers.xray]
message XRayConfig {
option (udpa.annotations.versioning).previous_message_type =
Expand Down
Loading