Skip to content

Commit

Permalink
Update observability.md (#1029)
Browse files Browse the repository at this point in the history
Remove TODOs and blank sections
Add TODOs to doc bug for tracking:
#732
  • Loading branch information
Clay-Mysten authored Mar 22, 2022
1 parent 505e979 commit 918f602
Showing 1 changed file with 0 additions and 12 deletions.
12 changes: 0 additions & 12 deletions doc/src/contribute/observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,6 @@ and analyzed for tracing, performance analysis, etc.
The idea is that every event and span would get tagged with key-value pairs. Events that log within any context or nested contexts would also inherit the context-level tags.
These tags represent *fields* that can be analyzed and filtered by. For example, one could filter out broadcasts and see the errors for all instances where the bad stake exceeded a certain amount, but not enough for an error.

TODO: see if keys need to be scoped by contexts

| Key | Place(s) | Meaning |
| ------------------- | ------------------ | -------------------------------------------------------------------------- |
| tx_digest | Gateway, Authority | Hex digest of transaction |
Expand Down Expand Up @@ -105,14 +103,6 @@ The `RUST_LOG` environment variable can be used to set both the overall logging
individual components, and even filtering down to specific spans or tags within spans are possible too.
For more details, please see the [EnvFilter](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html) docs.

## (Re)Configuration

## Observability of MOVE programs, events, etc.

TODO.

We need to provide means to authenticate the events etc (by linking them to signed effects).

## Viewing logs, traces, metrics

The tracing architecture is based on the idea of [subscribers](https://github.com/tokio-rs/tracing#project-layout) which
Expand Down Expand Up @@ -167,6 +157,4 @@ Also notice `elapsed_milliseconds` which logs the duration of each span.

[Tokio-console](https://github.com/tokio-rs/console) is an awesome CLI tool designed to analyze and help debug Rust apps using Tokio, in real time! It relies on a special subscriber.

TODO: Add instructions for setting env var and building Sui specially to enable Tokio-console support.

NOTE: Adding Tokio-console support may significantly slow down Sui authorities/gateways.

0 comments on commit 918f602

Please sign in to comment.