https://github.com/squiddev-cc/cc-prometheus

A prometheus exporter for ComputerCraft and CC:Tweaked
https://github.com/squiddev-cc/cc-prometheus

computercraft prometheus

Last synced: 10 months ago
JSON representation

A prometheus exporter for ComputerCraft and CC:Tweaked

• Host: GitHub
• URL: https://github.com/squiddev-cc/cc-prometheus
• Owner: SquidDev-CC
• License: bsd-3-clause
• Created: 2018-04-23T16:00:50.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-08-26T12:52:33.000Z (over 1 year ago)
• Last Synced: 2025-03-27T18:22:28.613Z (10 months ago)
• Topics: computercraft, prometheus
• Language: Java
• Size: 225 KB
• Stars: 10
• Watchers: 0
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# CC Prometheus Exporter

Exposes [Prometheus] metrics for [CC: Tweaked] and [CC: Restitched]. This provides the following metrics:

 - Total number of computers.

 - Total number of on computers.

 - Per-computer breakdown of all fields in `/computercraft profile`, including:

   - Time taken on the computer thread.

   - Time taken on the server thread.

   - HTTP usage (bandwidth, number of requests).

 - Number of threads in CC's underlying thread groups.

We also provide several non-CC related exporters, which are disabled by default. These are not designed to be

comprehensive (better monitoring solutions exist!) but are useful when you only need some basic monitoring and are

already running this.

 - All standard JVM metrics (memory, GC, thread counts).

 - Basic statistics about Minecraft:

   - Player count (total and per-dimension).

   - Chunks loaded per-dimension.

   - TPS (rolling average and as a histogram).

## Usage

Download the mod from the releases page and drop it into your `mods/` folder. Be careful to pick the correct jar for

Forge or Fabric!

Start your server, metrics are available at . This can be configured with the config

file, located at `/serverconfig/ccprometheus.toml`.

## Credits

The project layout is based on Jared's [MultiLoader Template](https://github.com/jaredlll08/MultiLoader-Template/).

[Prometheus]: https://prometheus.io/

[CC: Tweaked]: https://github.com/cc-tweaked/CC-Tweaked

[CC: Restitched]: https://github.com/cc-tweaked/cc-restitched