https://github.com/skilld-labs/railigentxotelreceiver
An opentelemetry collector for Siemens Railigent X
https://github.com/skilld-labs/railigentxotelreceiver
Last synced: 3 months ago
JSON representation
An opentelemetry collector for Siemens Railigent X
- Host: GitHub
- URL: https://github.com/skilld-labs/railigentxotelreceiver
- Owner: skilld-labs
- License: mit
- Created: 2024-04-24T14:43:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-06T10:04:34.000Z (5 months ago)
- Last Synced: 2025-03-13T07:02:26.920Z (3 months ago)
- Language: Go
- Size: 10.7 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RailigentX Receiver
This project provides an OpenTelemetry receiver that scrapes metrics from the RailigentX API and sends them to a [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/quick-start/).
## Table of Contents
- [Overview](#overview)
- [Features](#features)
- [Installation](#installation)
- [Configuration](#configuration)
- [Logging](#logging)
- [Contributing](#contributing)
- [License](#license)
## Overview
The RailigentX Receiver is a component for the [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/quick-start/) that collects metrics from the RailigentX API.
It scrapes data from RailigentX at specified intervals and transforms the data into OpenTelemetry metrics which are then consumed by the Collector.
## Features
- Scrapes asset metrics such as GPS location, mileage, and speed from RailigentX (more TODO).
- Periodic scraping at user-defined intervals.
- Configurable logging for monitoring and debugging.
## Installation
To build a custom collector that includes the RailigentX receiver, you can use the following `builder-config.yaml` configuration (eg here to scrape railigentx metrics and export them with prometheus):
```yaml
dist:
name: custom-otelcol
description: "Custom OpenTelemetry Collector with RailigentX Receiver"
output_path: ./dist
receivers:
- gomod:
github.com/skilld-labs/railigentxotelreceiver v1.0.12
exporters:
- gomod:
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusexporter v0.100.0
```
To build and run the custom collector:
1. Install the OpenTelemetry Collector builder:
```bash
go install go.opentelemetry.io/collector/cmd/[email protected]
```
Click [here](https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder) for more details
2. Create the custom collector using the builder configuration:
```bash
builder --config builder-config.yaml
```
3. Create a configuration file `config.yaml` for the collector [see instructions](#configuration)
3. Run the custom collector:
```bash
./dist/custom-otelcol --config config.yaml
```
## Configuration
The receiver requires a configuration file to specify settings such as the RailigentX API credentials, scrape interval, and logging level. Below is an example configuration file:
```yaml
receivers:
railigentx:
base_url: "https://api.railigentx.com"
username: yourusername
password: yourpassword
scrape_interval: 10s
asset_metric_repository:
name: bbolt
config:
db_path: /tmp/db
exporters:
prometheus:
endpoint: "0.0.0.0:9090"
resource_to_telemetry_conversion:
enabled: true
service:
pipelines:
metrics:
receivers: [railigentx]
exporters: [prometheus]
telemetry:
logs:
level: debug
```
### Configuration Options
- `base_url`: The RailigentX API base URL.
- `username`: Your RailigentX username.
- `password`: Your RailigentX password.
- `scrape_interval`: The interval at which the receiver scrapes metrics from RailigentX (e.g., `60s` for 60 seconds).
- `asset_metric_repository`: This is the configuration for keeping metrics timestamps informations and avoid sending multiple times metrics points that have already been collected. There are currently two implementations: [inmem](#inmem-repository) and [bbolt](#bbolt-repository).
#### Inmem Repository
The Inmem repository will keep metrics timestamps in memory. It doesn't require any storage space, but as a side effect, it could send multiple times the same metrics informations in case of restart of the application.
#### Bbolt Repository
The Bbolt repository will keep metrics timestamps in a dedicated db file. In case of application restart, it will use this database to know if metrics has been already send or not.
Configuration:
- `db_path`: The path of the file where database will be stored.
## Logging
The receiver uses the `zap` logger for logging. The logging configuration can be adjusted in the configuration file. The logs provide detailed information about the lifecycle of the receiver, the scraping process, and any errors encountered.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request on GitHub. Ensure your code adheres to the project's coding standards and includes appropriate tests.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.