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.

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

fix(telemetry): display custom event attributes properly on subscription events #6033

Merged
merged 8 commits into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
23 changes: 23 additions & 0 deletions .changesets/fix_bnjjj_fix_telemetry_on_event.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
### Display custom event attributes properly on subscription events ([PR #6033](https://github.com/apollographql/router/pull/6033))

Custom event attributes set using selectors at the supergraph level is now displayed properly. Example of configuration:

```yaml title=router.yaml
telemetry:
instrumentation:
events:
supergraph:
supergraph.event:
message: supergraph event
on: event_response # on every supergraph event (like subscription event for example)
level: info
attributes:
test:
static: foo
response.data:
response_data: $ # Display all the response data payload
response.errors:
response_errors: $ # Display all the response errors payload
```

By [@bnjjj](https://github.com/bnjjj) in https://github.com/apollographql/router/pull/6033
6 changes: 6 additions & 0 deletions .changesets/fix_latte_lens_tent_blaze.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
### Don't send `apollo_private.*` attributes to Jaeger collector ([PR #6033](https://github.com/apollographql/router/pull/6033))

abernix marked this conversation as resolved.
Show resolved Hide resolved

When using Jaeger collector to send traces you will no longer receive useless span attributes prefixed with `apollo_private.`
abernix marked this conversation as resolved.
Show resolved Hide resolved

By [@bnjjj](https://github.com/bnjjj) in https://github.com/apollographql/router/pull/6033
6 changes: 5 additions & 1 deletion apollo-router/src/plugins/telemetry/config_new/events.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ use parking_lot::Mutex;
use schemars::JsonSchema;
use serde::Deserialize;
use tower::BoxError;
use tracing::info_span;
use tracing::Span;

use super::instruments::Instrumented;
Expand Down Expand Up @@ -738,7 +739,10 @@ where
let mut new_attributes = selectors.on_response_event(response, ctx);
attributes.append(&mut new_attributes);
}

// Dumb span to make sure the custom attributes are saved in current span extensions
abernix marked this conversation as resolved.
Show resolved Hide resolved
// It won't be extracted or sampled at all
let span = info_span!("supergraph_event_send_event");
let _entered = span.enter();
inner.send_event(attributes);
}

Expand Down
4 changes: 3 additions & 1 deletion apollo-router/src/plugins/telemetry/dynamic_attribute.rs
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,9 @@ impl EventDynAttribute for ::tracing::Span {
self.with_subscriber(move |(id, dispatch)| {
if let Some(reg) = dispatch.downcast_ref::<Registry>() {
match reg.span(id) {
None => eprintln!("no spanref, this is a bug"),
None => {
eprintln!("no spanref, this is a bug");
bnjjj marked this conversation as resolved.
Show resolved Hide resolved
}
Some(s) => {
if s.is_sampled() {
let mut extensions = s.extensions_mut();
Expand Down
3 changes: 2 additions & 1 deletion apollo-router/src/plugins/telemetry/tracing/jaeger.rs
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,8 @@ impl TracingConfigurator for Config {
Ok(builder.with_span_processor(
BatchSpanProcessor::builder(exporter, runtime::Tokio)
.with_batch_config(batch_processor.clone().into())
.build(),
.build()
.filtered(),
))
}
_ => Ok(builder),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,12 @@ telemetry:
eq:
- "log"
- response_header: "x-log-request"
my.response_event.on_event:
message: "my response event message"
level: warn
on: event_response
attributes:
on_supergraph_response_event: on_supergraph_event
subgraph:
# Standard events
request: info
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ telemetry:
eq:
- "log"
- request_header: "x-log-request"
my.response_event.on_event:
message: "my response event message"
level: warn
on: event_response
attributes:
on_supergraph_response_event: on_supergraph_event
my.request.event:
message: "my event message"
level: info
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,12 @@ telemetry:
eq:
- "log"
- request_header: "x-log-request"
my.response_event.on_event:
message: "my response event message"
level: warn
on: event_response
attributes:
on_supergraph_response_event: on_supergraph_event
my.request.event:
message: "my event message"
level: info
Expand Down
12 changes: 12 additions & 0 deletions apollo-router/tests/integration/telemetry/logging.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ async fn test_json() -> Result<(), BoxError> {
router.execute_query(&query).await;
router.assert_log_contains(r#""static_one":"test""#).await;
router.execute_query(&query).await;
router
.assert_log_contains(r#""on_supergraph_response_event":"on_supergraph_event""#)
.await;
router.execute_query(&query).await;
router.assert_log_contains(r#""response_status":200"#).await;
router.graceful_shutdown().await;

Expand Down Expand Up @@ -160,6 +164,10 @@ async fn test_json_sampler_off() -> Result<(), BoxError> {
router.execute_query(&query).await;
router.assert_log_contains(r#""static_one":"test""#).await;
router.execute_query(&query).await;
router
.assert_log_contains(r#""on_supergraph_response_event":"on_supergraph_event""#)
.await;
router.execute_query(&query).await;
router.assert_log_contains(r#""response_status":200"#).await;
router.graceful_shutdown().await;

Expand Down Expand Up @@ -188,6 +196,10 @@ async fn test_text() -> Result<(), BoxError> {
router.assert_log_contains("trace_id").await;
router.execute_query(&query).await;
router.assert_log_contains("span_id").await;
router
.assert_log_contains(r#"on_supergraph_response_event=on_supergraph_event"#)
.await;
router.execute_query(&query).await;
router.execute_query(&query).await;
router.assert_log_contains("response_status=200").await;
router.graceful_shutdown().await;
Expand Down
Loading