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
Cross-language parity
This is a docs-only change. Same env vars work for both languages.
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.
Context
ZM_RTMS_LOG_FORMAT=jsonalready 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, orexamples/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
ZM_RTMS_LOG_FORMAT=jsonto the README's environment variables sectionjsonformat with reasoningexamples/python.mdandexamples/node.mdenv-var tablesZM_RTMS_LOG_LEVELandZM_RTMS_LOG_ENABLEDcompanions in the same placeAcceptance criteria
ZM_RTMS_LOG_FORMAT,ZM_RTMS_LOG_LEVEL,ZM_RTMS_LOG_ENABLEDjson+ explains whyexamples/python.mdandexamples/node.mdmention the env varsCross-language parity
This is a docs-only change. Same env vars work for both languages.
examples/python.mdupdatedexamples/node.mdupdatedSource
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.