Skip to content

[v1.2] Document ZM_RTMS_LOG_FORMAT=json + companions in quickstart and examples #119

@MaxMansfield

Description

@MaxMansfield

Context

ZM_RTMS_LOG_FORMAT=json already exists as an SDK env var that switches the SDK's internal log format from human-readable ("progressive") to machine-readable JSON. It's not mentioned in the quickstart, the README, or examples/python.md / examples/node.md.

For cloud deployments (CloudWatch Logs Insights, Datadog, Splunk, Loki, etc.), JSON format is the right default. Customers shouldn't have to grep the SDK source to discover this exists.

What to ship

  • Add ZM_RTMS_LOG_FORMAT=json to the README's environment variables section
  • Add a "Deploying to production / cloud" subsection that recommends json format with reasoning
  • Add it to examples/python.md and examples/node.md env-var tables
  • Document the ZM_RTMS_LOG_LEVEL and ZM_RTMS_LOG_ENABLED companions in the same place

Acceptance criteria

  • README env-var section lists ZM_RTMS_LOG_FORMAT, ZM_RTMS_LOG_LEVEL, ZM_RTMS_LOG_ENABLED
  • Cloud-deploy subsection recommends json + explains why
  • examples/python.md and examples/node.md mention the env vars
  • CHANGELOG note (no code change required)

Cross-language parity

This is a docs-only change. Same env vars work for both languages.

  • README updated
  • examples/python.md updated
  • examples/node.md updated

Source

Tracked in vault: Projects/RTMS SDK v1.2.md → DEVS-X8.

Tracker

Part of the v1.2 milestone. Project: https://github.com/orgs/zoom/projects/11.

Metadata

Metadata

Assignees

No one assigned

    Labels

    cloud deployAffects Docker / ECS / Fargate / Kubernetes deploymentsdocumentationImprovements or additions to documentationv1.2Part of the v1.2 release

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions