Skip to content

Latest commit

 

History

History
54 lines (42 loc) · 2.18 KB

backend-meter.md

File metadata and controls

54 lines (42 loc) · 2.18 KB

Meter Receiver

Meter receiver is accepting the metrics of meter protocol format into the Meter System.

Module define

receiver-meter:
  selector: ${SW_RECEIVER_METER:default}
  default:

In Kafka Fetcher, we need to follow the configuration to enable it.

kafka-fetcher:
  selector: ${SW_KAFKA_FETCHER:default}
  default:
    bootstrapServers: ${SW_KAFKA_FETCHER_SERVERS:localhost:9092}
    enableMeterSystem: ${SW_KAFKA_FETCHER_ENABLE_METER_SYSTEM:true}

Configuration file

Meter receiver is configured via a configuration file. The configuration file defines everything related to receiving from agents, as well as which rule files to load.

OAP can load the configuration at bootstrap. If the new configuration is not well-formed, OAP fails to start up. The files are located at $CLASSPATH/meter-analyzer-config.

The file is written in YAML format, defined by the scheme described below. Brackets indicate that a parameter is optional.

A example can be found here. If you're using Spring sleuth, you could use Spring Sleuth Setup.

Meters configure

# expSuffix is appended to all expression in this file.
expSuffix: <string>
# insert metricPrefix into metric name:  <metricPrefix>_<raw_metric_name>
metricPrefix: <string>
# Metrics rule allow you to recompute queries.
metricsRules:
  # The name of rule, which combinates with a prefix 'meter_' as the index/table name in storage.
  name: <string>
  # MAL expression.
  exp: <string>

More about MAL, please refer to mal.md

About rate, irate, increase

Even we supported rate, irate, increase function in the backend, but we still recommend user to consider using client-side APIs to do these. Because

  1. The OAP has to set up caches to calculate the value.
  2. Once the agent reconnected to another OAP instance, the time windows of rate calculation will break. Then, the result would not be accurate.