Skip to content

feat(native): update custom instrumentation #11511

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

Merged
merged 3 commits into from
Oct 10, 2024
Merged

feat(native): update custom instrumentation #11511

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ca87a3
fix(native): code snippet syntax
JoshuaMoelans Oct 8, 2024
bc477ac
feat(native): update sentry-trace header format
JoshuaMoelans Oct 8, 2024
71c7489
add explanation about format mismatch
JoshuaMoelans Oct 8, 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
23 changes: 11 additions & 12 deletions platform-includes/distributed-tracing/custom-instrumentation/native.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,21 @@ To obtain headers from a transaction so it can be continued from a downstream se

```c
static void
copy_headers_to(const char *key, const char *value, void *userdata)
{
sentry_value_t *headers
= (sentry_value_t *)userdata;
sentry_value_set_by_key(*headers, key, value);
copy_headers_to(const char *key, const char *value, void *userdata) {
sentry_value_t *headers = (sentry_value_t *)userdata;
sentry_value_set_by_key(*headers, key, sentry_value_new_string(value));
}

int main(int argc, char **argv) {
...
// Transaction to continue off of
// Transaction to continue off of
sentry_transaction_context_t *tx_ctx = sentry_transaction_context_new(
"honk",
NULL,
NULL
);
sentry_transaction_t *tx = sentry_transaction_start(tx_ctx, sentry_value_new_null());

sentry_value_t *headers = sentry_value_new_object();
sentry_transaction_iter_headers(tx, copy_headers_to, (void *)headers);
sentry_value_t headers = sentry_value_new_object();
sentry_transaction_iter_headers(tx, copy_headers_to, (void *) &headers);
}
```

Expand All @@ -34,12 +31,14 @@ To create a transaction as a continuation of a trace retrieved from an upstream
```c
sentry_transaction_context_t *tx_ctx = sentry_transaction_context_new(
"honk",
NULL,
NULL
);
sentry_transaction_context_update_from_header(
tx_ctx,
"sentry-trace",
"atraceid-aspanid-issampled",
"41c74c2ea9f2bfb184f86939de5b97aa-399b3e5cc8b83494-1"
);

```

The format of the `sentry-trace` header should follow the one defined in [the telemetry docs](https://develop.sentry.dev/sdk/telemetry/traces/#header-sentry-trace). It should consist of a 32 character hexadecimal string for the `traceId`, followed by a 16 character hexadecimal string for the `spanId` and an optional single character for the `sampled` flag. If the given string doesn't match this format, the update is ignored and the values in the transaction context will remain unchanged.
Loading