Skip to content

Home

Jump to bottom
Jeffrey Jones edited this page Mar 14, 2023 · 14 revisions

Example Setup

This setup is an example that uses the Grafana cloud to collect, store and display metrics.

Note that, even as an example guide, it is expected that readers are technologically savvy and able to explore new systems by themselves without relying on hand-holding as.

Familiarity with the OpenTelemetry ecosystem is a big advantage.

Grafana setup

Go to https://grafana.com/ and register a free account. Grafana prides itself on having an (actually useful) free forever plan. The amount of Data collected by Telemachus can fit within these limits.

Minimal OpenTelemetry Collector

See this guide for getting started with the Open Telemetry collector. An example OpenTelemetry Collector that connects to the Grafana cloud is below. Make sure to replace the placeholder values with real values taken from your Grafana account Prometheus endpoint settings.

receivers:
  otlp:
    protocols:
      grpc:

processors:
  batch:

exporters:
  logging:
  prometheusremotewrite:
    # For example: https://12345:afakagwuefygkufg@prometheus-prod-10-prod-us-central-0.grafana.net/api/prom/push
    endpoint: "https://YOUR_ACCOUNT_ID:YOUR_APP_TOKEN@THE_PUSH_URL"

service:
 pipelines:
   metrics:
     receivers: [otlp]
     processors: [batch]
     exporters: [prometheusremotewrite, logging]

For a more in-depth configuration file that relies on the Contrib release of OpenTelemetry see [OpenTelemetry Advanced Config]

Telemachus

  1. Download Telemachus from URL and extract into a folder of your choice.
  2. Modify the configuration.yaml file to suit your installation. The file has comments that explain the various options.
  3. Run the bot using the Telemachus.exe or optionally run as a Windows Service (See below). For the initial runs we recommend not running as a service to make sure everything is setup correctly.

Install as a windows service

Run the following command in a Powershell window with administrator permissions, making sure to change the path to point to the correct location.

New-Service -Name Telemachus -BinaryPathName C:\YOUR\PATH\TO\Telemachus.exe -Description "Metrics application for DCS-gRPC" -DisplayName "Telemachus" -StartupType Automatic
Clone this wiki locally