matrix-public-archive

History

Eric Eastwood 57d2cb3dd3 Refactor tests to use single source of truth ASCII diagram (#164 ) - Less test bulk - Single source of truth: there is no mismatch between the comment and the expectations (we already caught a few mistakes in the conversion thanks to this benefit) - Easier to maintain and update		2023-04-07 12:52:41 -05:00
..
child-process-runner	Add a way to select time of day (#139 )	2023-04-05 04:25:31 -05:00
hydrogen-render	Only assign `vmContext.global.crypto` if not already global (#143 )	2022-11-18 12:27:50 -06:00
lib	Add a way to select time of day (#139 )	2023-04-05 04:25:31 -05:00
routes	Refactor tests to use single source of truth ASCII diagram (#164 )	2023-04-07 12:52:41 -05:00
tracing	Add domain to tracing service to distinguish different Matrix public archive instances (#76 )	2022-10-11 16:03:33 -05:00
README.md	Add available Jaeger port (#48 )	2022-08-29 14:08:15 -05:00
server.js	Enable tracing by config so we can enable from argv, env variable, or config file (#41 )	2022-07-14 11:26:53 -05:00
start-dev.js	Show surrounding messages for a full screen of content (#71 )	2022-09-20 16:02:09 -05:00

README.md

Tracing

Run the app with the OpenTelemetry tracing.

npm run start -- --tracing
# or
npm run start-dev -- --tracing

Manually:

node --require './server/tracing.js' server/server.js

Traces are made up of many spans. Each span defines a traceId which it is associated with.

Viewing traces in Jaeger

Dashboard where users can see visualisations -> http://localhost:16686

via https://www.jaegertracing.io/docs/1.35/getting-started/

docker run -d --name jaeger \
  -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
  -e COLLECTOR_OTLP_ENABLED=true \
  -p 6831:6831/udp \
  -p 6832:6832/udp \
  -p 5778:5778 \
  -p 5775:5775/udp \
  -p 16686:16686 \
  -p 4317:4317 \
  -p 4318:4318 \
  -p 14250:14250 \
  -p 14268:14268 \
  -p 14269:14269 \
  -p 9411:9411 \
  jaegertracing/all-in-one:1.35

Port	Protocol	Component	Function
6831	UDP	agent	accept jaeger.thrift over Thrift-compact protocol (used by most SDKs)
6832	UDP	agent	accept jaeger.thrift over Thrift-binary protocol (used by Node.js SDK)
5775	UDP	agent	(deprecated) accept zipkin.thrift over compact Thrift protocol (used by legacy clients only)
5778	HTTP	agent	serve configs (sampling, etc.)
16686	HTTP	query	serve frontend
4317	HTTP	collector	accept OpenTelemetry Protocol (OTLP) over gRPC, if enabled
4318	HTTP	collector	accept OpenTelemetry Protocol (OTLP) over HTTP, if enabled
14268	HTTP	collector	accept jaeger.thrift directly from clients
14250	HTTP	collector	accept model.proto
9411	HTTP	collector	Zipkin compatible endpoint (optional)

With Service Performance Monitoring (SPM)