Getting started with Monium

Log in to the management console or sign up. If not signed up yet, navigate to the management console and follow the instructions.

On the Yandex Cloud Billing page, make sure you have a linked billing account with the ACTIVE or TRIAL_ACTIVE status. If you do not have a billing account yet, create one.

If you have an active billing account, you can navigate to the cloud page to create or select a folder for your infrastructure.

Learn more about clouds and folders here.

In the management console, navigate to the folder where you want to store your telemetry.

Go to Identity and Access Management.

Click Create service account.

Enter a name for the service account, e.g., monium-ca.

Click Add role and add monium.telemetry.writer.
If you plan to transfer only particular data types, instead of monium.telemetry.writer, select one or more of the following roles: monium.metrics.writer, monium.logs.writer, and monium.traces.writer.

Click Create.

Select the account you created from the list.

In the top panel, click Create new key and select Create API key.

Select Scope: yc.monium.telemetry.write.

Optionally, specify Expires at.

Click Create.

Save the secret key for the next step.

Set these environment variables:

• MONIUM_PROJECT: Monium project name.

  By default, when you create a cloud and folder, two projects are created: cloud__<cloud_ID> and folder__<folder_ID>. You can also create other projects.

  To test Monium, you can specify a project folder, e.g., folder__b1g86q4m5vej********.

  If entering it manually, make sure that folder is followed by two underscores.

• MONIUM_API_KEY: API key.

Set up your application to send OTLP telemetry:

• Install the auto-instrumentation agent to automatically collect some telemetry data and send it to OTLP.
• Add the OpenTelemetry SDK to your app.

Install OTel Collector.

You can send data to Monium directly from the OpenTelemetry SDK, without using the agent.

In the otel-collector.yaml configuration file, configure data transfer to Monium.

Example of a minimal otel-collector.yaml configuration:

receivers:       
  otlp:          # Target type: OTLP
    protocols:   # Protocols that OTel Collector listens to
      grpc:      # gRPC, default port 4317
      http:      # HTTP, default port 4318

processors:
  cumulativetodelta:
  batch:

exporters:       # Connecting to Monium
  otlp/monium:
    compression: zstd
    endpoint: ingest.monium.yandex.cloud:443
    headers:
      Authorization: "Api-Key ${env:MONIUM_API_KEY}"
      x-monium-project: "${env:MONIUM_PROJECT}"

service:         
  pipelines:
    metrics:                 # Transferring metrics
      receivers: [ otlp ]
      processors: [ batch, cumulativetodelta ]
      exporters: [ otlp/monium ]
    traces:                  # Transferring traces
      receivers: [ otlp ]
      processors: [ batch ]
      exporters: [ otlp/monium ]
    logs:                    # Transferring logs
      receivers: [ otlp ]
      processors: [ batch ]
      exporters: [ otlp/monium ]

Set the environment variables to distribute data across shards in Monium:

• OTEL_SERVICE_NAME: Name of your application or service.
• OTEL_RESOURCE_ATTRIBUTES="cluster=my-cluster": Name of the installation the application operates in, e.g., production or test environment. This is an optional setting. The default value is cluster=default.

Run your app and start sending telemetry.

On the Monium home page, select Shards on the left.

In the list, select the shard with your service name.

The shard name follows the <project_name>_<cluster_name>_<service_name> format, e.g., folder__b1g86q4m5vej********_default_spring-petclinic.

To view a specific data type, on the left, select:

• Metrics.

  In the query string, select project, cluster, and service one by one and click Execute query.

  Example of a chart with metrics

  

  Learn more about using metrics.

• Logs.

  In the query string, select project, cluster, and service one by one and click Execute query.

  Example of a page with logs

  

  Learn more on how to use logs.

• Traces.

  In the query string, select project and service one by one and click Execute.

  Example of a page with traces

  

  Learn more on how to use traces.

Install Git and Java suitable for your OS. Here is an example:

sudo apt update
sudo apt install -y git openjdk-17-jdk

Download and install OTel Collector suitable for your OS. Here is an example:

wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v144.0/otelcol-linux_amd64.tar.gz
tar xvf otelcol-linux_amd64.tar.gz

Set these environment variables:

export MONIUM_PROJECT=folder__<folder_ID>
export MONIUM_API_KEY=<API_key>

Create a file named stream_put_record.py and paste the following code to it:

receivers:
  otlp:
    protocols:
      grpc:
      http:

exporters:
  otlp_grpc/monium:
    compression: zstd
    endpoint: ingest.monium.yandex.cloud:443
    headers:
      Authorization: "Api-Key ${env:MONIUM_API_KEY}"
      x-monium-project: "${env:MONIUM_PROJECT}"
    sending_queue:
      batch:

service:
  pipelines:
    metrics:
      receivers: [ otlp ]
      exporters: [ otlp_grpc/monium ]
    traces:
      receivers: [ otlp ]
      exporters: [ otlp_grpc/monium ]
    logs:
      receivers: [ otlp ]
      exporters: [ otlp_grpc/monium ]
  telemetry:
    metrics:
      level: normal
      readers:
        - periodic:
            exporter:
              otlp:
                protocol: http/protobuf
                endpoint: http://localhost:4318
            interval: 30000
            timeout: 5000

Run OTel Collector:

./otelcol-linux_amd64 --config otel-collector.yaml

It will start listening on ports 4317 (gRPC) and 4318 (HTTP).

Download and build Spring PetClinic:

git clone https://github.com/spring-projects/spring-petclinic
cd spring-petclinic
./mvnw -DskipTests package

Download the OpenTelemetry Java agent:

curl -L -o opentelemetry-javaagent.jar \
https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar

Run the application with the Java agent to send telemetry to OTel Collector:

OTEL_SERVICE_NAME=spring-petclinic \
OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE="delta" \
java -javaagent:./opentelemetry-javaagent.jar -jar target/*.jar

Open the Spring PetClinic website at http://localhost:8080 and simulate user actions.