Skip to content

Commit 5713f1f

Browse files
committed
Update observability documentation to enhance clarity on OpenTelemetry data export links and improve the descriptions of spans and attributes. This includes correcting links for exporting OpenTelemetry data, refining the section on missing instrumentation, and updating references to the Durable Object Storage SQL and KV APIs for better user guidance.
1 parent 1915d74 commit 5713f1f

File tree

3 files changed

+19
-15
lines changed

3 files changed

+19
-15
lines changed

src/content/docs/workers/observability/traces/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Or if you have already set `observability.enabled = true` in your wrangler confi
5353
Workers tracing follows [OpenTelemetry (OTel) standards](https://opentelemetry.io/), making it compatible with popular observability platforms while requiring zero development effort from you.
5454
If your observability provider has an available OpenTelemetry endpoint, you can export traces (and logs!)
5555

56-
Learn more about exporting OpenTelemetry data from Workers to your provider of choice [here](workers/observability/exporting-opentelemetry-data/index.mdx).
56+
Learn more about exporting OpenTelemetry data from Workers to your provider of choice [here](workers/observability/exporting-opentelemetry-data/).
5757

5858
### Sampling
5959

src/content/docs/workers/observability/traces/known-limitations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ One of the key aspects of distributed tracing is ensuring trace context flows ac
1414

1515
Without trace context propagation, you will also see an additional trace whenever your Worker is making a call to another Worker via service bindings or to a Durable Object.
1616

17-
### Support for more spans and attributes
18-
We are adding more automatic instrumentation for every part of the Workers platform. While we first want to give you visibility into the duration of every operation within your request, we also planning to add more detailed attributes on each span. You can find a complete list of what is already instrumented [here](link). Your [feedback](link) on what’s missing will help us prioritize accordingly.
17+
### Missing instrumentation for some spans and attributes
18+
We are adding more automatic instrumentation for every part of the Workers platform. While we first want to give you visibility into the duration of every operation within your request, we also planning to add more detailed attributes on each span. You can find a complete list of what is already instrumented [here](/workers/observability/traces/spans-and-attributes). Your feedback on what’s missing will help us prioritize accordingly.
1919

2020
### Support for custom spans and attributes:
2121
While automatic instrumentation covers the platform interactions, we know you need visibility into your own application logic too. We're working to support the [OpenTelemetry API](https://www.npmjs.com/package/@opentelemetry/api) to make it easier for you to instrument custom spans within your application.

src/content/docs/workers/observability/traces/spans-and-attributes.mdx

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ Cloudflare Workers provides automatic tracing instrumentation **out of the box**
410410

411411
---
412412

413-
### [Dispatch Namespace](/workers/runtime-apis/bindings/dispatch-namespace/)
413+
### Dispatch Namespace
414414

415415
#### [`wfp_get`](/cloudflare-for-platforms/workers-for-platforms/get-started/dynamic-dispatch/#configure-the-dispatch-namespace-binding)
416416
- `cloudflare.dispatch_namespace`
@@ -435,46 +435,49 @@ RPC calls to your Durable Object (e.g. `env.MY_DO.fetch()`, `env.MY_DO.myMethod(
435435
---
436436

437437
### [Durable Object Storage SQL API](/durable-objects/api/storage-api/)
438+
The SQL API allow you to modify the SQLite database embedded within a Durable Object.
438439

439440
#### Attributes availabe on all Durable Object Storage SQL API
440441

441442
- `cloudflare.durable_object.id`
442443
- `db.system.name`
443444
- `db.operation.name`
444445

445-
#### [`durable_object_storage_getDatabaseSize`](/durable-objects/api/storage-api/#sql-api)
446+
#### [`durable_object_storage_exec`](/durable-objects/api/sqlite-storage-api/#exec)
447+
448+
#### [`durable_object_storage_getDatabaseSize`](/durable-objects/api/sqlite-storage-api/#databasesize)
446449

447450
- `cloudflare.durable_object.sql.query.statement`
448451
- `cloudflare.durable_object.sql.query.bindings`
449452
- `cloudflare.durable_object.sql.response.rows_read`
450453
- `cloudflare.durable_object.sql.response.rows_written`
451454
- `cloudflare.durable_object.sql.response.db_size`
452455

453-
#### [`durable_object_storage_ingest`](/durable-objects/api/storage-api/#sql-api)
456+
#### `durable_object_storage_ingest`
454457

455458
- `db.system`
456459
- `db.operation.name`
457460
- `cloudflare.durable_object.response.rows_read`
458461
- `cloudflare.durable_object.response.rows_written`
459462
- `cloudflare.durable_object.response.statement_count`
460463

461-
#### [`durable_object_storage_kv_get`](/durable-objects/api/storage-api/#get)
464+
#### [`durable_object_storage_kv_get`](/durable-objects/api/sqlite-storage-api/#get)
462465

463466
- `cloudflare.durable_object.kv.query.keys`
464467
- `cloudflare.durable_object.kv.query.keys.count`
465468

466-
#### [`durable_object_storage_kv_put`](/durable-objects/api/storage-api/#put)
469+
#### [`durable_object_storage_kv_put`](/durable-objects/api/sqlite-storage-api/#put)
467470

468471
- `cloudflare.durable_object.kv.query.keys`
469472
- `cloudflare.durable_object.kv.query.keys.count`
470473

471-
#### [`durable_object_storage_kv_delete`](/durable-objects/api/storage-api/#delete)
474+
#### [`durable_object_storage_kv_delete`](/durable-objects/api/sqlite-storage-api/#delete)
472475

473476
- `cloudflare.durable_object.kv.query.keys`
474477
- `cloudflare.durable_object.kv.query.keys.count`
475478
- `cloudflare.durable_object.kv.response.deleted_count`
476479

477-
#### [`durable_object_storage_kv_list`](/durable-objects/api/storage-api/#list)
480+
#### [`durable_object_storage_kv_list`](/durable-objects/api/sqlite-storage-api/#list)
478481

479482
- `cloudflare.durable_object.kv.query.start`
480483
- `cloudflare.durable_object.kv.query.startAfter`
@@ -486,29 +489,30 @@ RPC calls to your Durable Object (e.g. `env.MY_DO.fetch()`, `env.MY_DO.myMethod(
486489
---
487490

488491
### [Durable Object Storage KV API](/durable-objects/api/storage-api/)
492+
The KV-backed API allows you to modify embedded storage within a Durable Object.
489493

490494
#### Attributes availabe on all Durable Object Storage KV API
491495

492496
- `db.operation.name`
493497
- `cloudflare.durable_object.id`
494498
- `db.system.name`
495499

496-
#### [`durable_object_storage_get`](/durable-objects/api/storage-api/#get)
500+
#### [`durable_object_storage_get`](/durable-objects/api/legacy-kv-storage-api/#do-kv-async-get)
497501

498502
- `cloudflare.durable_object.kv.query.keys`
499503
- `cloudflare.durable_object.kv.query.keys.count`
500504
- `cloudflare.durable_object.kv.query.allow_concurrency`
501505
- `cloudflare.durable_object.kv.query.no_cache`
502506

503-
#### [`durable_object_storage_put`](/durable-objects/api/storage-api/#put)
507+
#### [`durable_object_storage_put`](/durable-objects/api/legacy-kv-storage-api/#do-kv-async-put)
504508

505509
- `cloudflare.durable_object.kv.query.keys`
506510
- `cloudflare.durable_object.kv.query.keys.count`
507511
- `cloudflare.durable_object.kv.query.allow_concurrency`
508512
- `cloudflare.durable_object.kv.query.no_cache`
509513
- `cloudflare.durable_object.kv.query.allow_unconfirmed`
510514

511-
#### [`durable_object_storage_delete`](/durable-objects/api/storage-api/#delete)
515+
#### [`durable_object_storage_delete`](/durable-objects/api/legacy-kv-storage-api/#do-kv-async-delete)
512516

513517
- `cloudflare.durable_object.kv.query.keys`
514518
- `cloudflare.durable_object.kv.query.keys.count`
@@ -517,7 +521,7 @@ RPC calls to your Durable Object (e.g. `env.MY_DO.fetch()`, `env.MY_DO.myMethod(
517521
- `cloudflare.durable_object.kv.query.allow_unconfirmed`
518522
- `cloudflare.durable_object.kv.response.deleted_count`
519523

520-
#### [`durable_object_storage_list`](/durable-objects/api/storage-api/#list)
524+
#### [`durable_object_storage_list`](/durable-objects/api/legacy-kv-storage-api/#do-kv-async-list)
521525

522526
- `cloudflare.durable_object.kv.query.start`
523527
- `cloudflare.durable_object.kv.query.startAfter`
@@ -528,7 +532,7 @@ RPC calls to your Durable Object (e.g. `env.MY_DO.fetch()`, `env.MY_DO.myMethod(
528532
- `cloudflare.durable_object.kv.query.allow_concurrency`
529533
- `cloudflare.durable_object.kv.query.no_cache`
530534

531-
#### [`durable_object_storage_deleteAll`](/durable-objects/api/storage-api/#deleteall)
535+
#### [`durable_object_storage_deleteAll`](/durable-objects/api/legacy-kv-storage-api/#deleteall)
532536

533537
- `cloudflare.durable_object.kv.query.allow_concurrency`
534538
- `cloudflare.durable_object.kv.query.no_cache`

0 commit comments

Comments
 (0)