ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-03-07 21:32:31 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
32d411ea25dbbdc5f37b3cb3b357001cfa42415e
rippled/docs
History
Pratik Mankawde 252a4bb8d2 Phase 1b: Telemetry core infrastructure 
Add the OpenTelemetry telemetry library and supporting infrastructure:

Build system:
- Conan opentelemetry-cpp dependency with OTLP/gRPC exporter
- CMake integration for xrpl_telemetry library target
- Levelization ordering updates

Core library (libxrpl):
- Telemetry class: provider lifecycle, span creation, sampling config
- SpanGuard: RAII span management with attribute/exception helpers
- TelemetryConfig: parse [telemetry] config section
- NullTelemetry: no-op implementation when telemetry is disabled

Application integration:
- Telemetry member in ApplicationImp with start/stop lifecycle
- getTelemetry() interface on Application
- ServiceRegistry telemetry accessor

Docker observability stack:
- OTel Collector, Jaeger, Grafana docker-compose setup
- Collector config with OTLP gRPC receiver and Jaeger exporter

Config and docs:
- Example telemetry config section in xrpld-example.cfg
- Build documentation for telemetry setup

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-27 17:53:25 +00:00
..
0001-negative-unl
refactor: Fix typos in comments, configure cspell (#6164)
2026-01-07 12:10:19 -05:00
0010-ledger-replay
chore: Fix file formatting (#5718)
2025-08-22 10:02:56 -04:00
build
Phase 1b: Telemetry core infrastructure
2026-02-27 17:53:25 +00:00
images
Set version to 1.5.0
2020-03-30 18:57:35 -04:00
CheatSheet.md
chore: Run prettier on all files (#5657)
2025-08-11 16:15:42 +00:00
CodingStyle.md
chore: Fix minor issues in comments (#6346)
2026-02-12 14:55:27 -05:00
consensus.md
refactor: Fix typos in comments, configure cspell (#6164)
2026-01-07 12:10:19 -05:00
Docker.md
Update Docker.md (#4432)
2023-03-02 10:07:09 -08:00
Doxyfile
chore: Fix documentation generation job: (#5091)
2024-08-15 17:03:50 -04:00
HeapProfiling.md
chore: Run prettier on all files (#5657)
2025-08-11 16:15:42 +00:00
NodeStoreRefactoringCaseStudy.pdf
Add dev docs generation to Jenkins:
2018-03-02 07:37:15 -08:00
README.md
chore: Fix docs readme and cmake (#6122)
2025-12-08 18:39:38 +00:00
sample_chart.doc
Add dev docs generation to Jenkins:
2018-03-02 07:37:15 -08:00

README.md

Building documentation

Dependencies

Install these dependencies:

  • Doxygen: All major platforms have official binary distributions, or you can build from source.

    • MacOS: We recommend installing via Homebrew: brew install doxygen. The executable will be installed in /usr/local/bin which is already in the default PATH.

      If you use the official binary distribution, then you'll need to make Doxygen available to your command line. You can do this by adding a symbolic link from /usr/local/bin to the doxygen executable. For example,

      $ ln -s /Applications/Doxygen.app/Contents/Resources/doxygen /usr/local/bin/doxygen

  • PlantUML:

    1. Install a functioning Java runtime, if you don't already have one.
    2. Download plantuml.jar.

  • Graphviz:

    • Linux: Install from your package manager.
    • Windows: Use an official installer.
    • MacOS: Install via Homebrew: brew install graphviz.

Docker

Instead of installing the above dependencies locally, you can use the official build environment Docker image, which has all of them installed already.

  1. Install Docker
  2. Pull the image:
sudo docker pull rippleci/rippled-ci-builder:2944b78d22db
  1. Run the image from the project folder:
sudo docker run -v $PWD:/opt/rippled --rm rippleci/rippled-ci-builder:2944b78d22db

Build

There is a docs target in the CMake configuration.

mkdir build
cd build
cmake -Donly_docs=ON ..
cmake --build . --target docs --parallel

The output will be in build/docs/html.