Skip to content

docs: Add Lore Server metrics and traces reference page - #1

Draft
ryanlitalien wants to merge 1 commit into
mainfrom
docs/add-lore-server-metrics-reference
Draft

docs: Add Lore Server metrics and traces reference page#1
ryanlitalien wants to merge 1 commit into
mainfrom
docs/add-lore-server-metrics-reference

Conversation

@ryanlitalien

@ryanlitalien ryanlitalien commented Jul 18, 2026

Copy link
Copy Markdown

TL;DR

Adds a source-verified, vendor-neutral OpenTelemetry metrics and traces reference page for Lore Server, resolving EpicGames#48. Docs-only, 2 files, DCO-signed. Draft against the fork main for internal review before any upstream submission.

What

Adds a Reference page, docs/reference/lore-server-metrics.md, that catalogs the OpenTelemetry metrics, spans, and attributes that Lore Server exposes. Also links it from the reference index and cross-links the telemetry settings in the server configuration reference.

Why

The docs state that Lore Server supports metrics, logs, and traces through OpenTelemetry, but there was no reference for which ones. Discovering them meant reading source or wiring up a collector and inspecting the output.

Contents

  • How metric names are built (<namespace>.<instrument>, the urc.* / lore.* split, helper-constructor types and units).
  • Shared context / success attributes and resource attributes.
  • HTTP and gRPC request metrics (OpenTelemetry semantic-convention names).
  • The recurring operation_duration pattern, with a namespace-to-context table.
  • Storage, QUIC transport, service counters, runtime metrics, and the traces / sampling model.

Notes

  • Vendor-neutral, per the docs language canon (no third-party backend names in the main docs).
  • Every instrument name, type, unit, and attribute was catalogued and spot-verified against the source. A stability note flags that the legacy urc.* internal instruments can change between releases.
  • Follows the Reference doc type and house style: single H1, indicative mood, tables for the surface, valid cross-page anchors.

Review focus

  • Accuracy of instrument names and context values.
  • Whether the low-level urc.* internal metrics (Tokio runtime, QUIC internals) should be documented in this depth or trimmed.

Lore Server documents that it supports metrics, logs, and traces
through OpenTelemetry, but there was no reference for which metrics,
spans, and attributes it actually exposes. Finding them meant reading
source or wiring up a collector and inspecting the output.

Add a Reference page cataloging the OpenTelemetry surface, grouped by
subsystem: the name-construction scheme, shared context/success
attributes, resource attributes, HTTP and gRPC request metrics, the
recurring operation_duration pattern, storage, QUIC transport, service
counters, runtime metrics, and the traces and sampling model. Link it
from the reference index and cross-link the telemetry settings in the
server configuration reference.

Addresses EpicGames#48

Signed-off-by: Ryan L'Italien <ryanlitalien@gmail.com>
@ryanlitalien
ryanlitalien force-pushed the docs/add-lore-server-metrics-reference branch from db44073 to 76d4d4c Compare July 18, 2026 01:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant