temporalio / temporalio/s2s-proxy

Prometheus output example

Open
#121 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Go
Stars
16
Forks
9
Avg merge
6d 23h
Merged PRs (30d)
12

Description

Attached is an example of the Prometheus metrics output from the S2S proxy. You can scrape this information with your preferred monitoring tool by observing [proxy-ip]:9090/metrics (you may set the metrics port in the proxy-config). Some key metrics to observe while your proxy is running:

  • temporal_s2s_proxy_mux_connection_active: This tells you how many mux connections your proxy has made. By default, the s2s proxy will attempt to maintain 10 open connections.
  • temporal_s2s_proxy_grpc_server_*: Standard GRPC server metrics are available in the "inbound" and "outbound" directions. The "inbound" server is the GRPC server receiving from your remote and transferring to the local Temporal cluster. The "outbound" server is the GRPC server receiving from your local Temporal cluster and transferring to the remote.
  • temporal_s2s_proxy_outbound_grpc_client_handled_total / temporal_s2s_proxy_inbound_grpc_client_handled_total: These are the standard GRPC client metrics, and can be paired with the above server metrics to diagnose whether a problem happened inside or outside your proxy deployment.
  • temporal_s2s_proxy_admin_service_streams_active: The number of replication streams active through the proxy. The sum of all active streams should equal your cluster's shard count.

prometheus-data.txt

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the attached prometheus-data.txt and the existing documentation around proxy-config and [proxy-ip]:9090/metrics. The issue does not identify a documentation file or a specific requested change, so confirm the intended location and scope first. Done should make the Prometheus endpoint and listed metrics understandable to users.

Written by the indexing model from the issue text.

Assessment

Tech stack
prometheus
Domain
observability
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.