Skip to main content

Metrics

An endpoint has been created to obtain the metrics of the Symphony project with NodeJS and to monitor them on the mirket platform.

Dependency versions​

The minimum required versions for symphony and symphony-cli are as follows:

PackageVersion
symphony@stechquick/symphony@0.2.13
symphony-cli@stechquick/symphony-cli@0.5.30

Activation​

To activate metric reporting, it will be sufficient to update to the currently communicated versions, as this value comes as true by default in the current version.

Additionally, the parameters that are optionally requested to be added are listed below:

  • Within the optional parameters, metric reporting can be disabled by setting the disabled parameter to true.

  • Optional parameters can be changed from the config.yaml file under the sym-engine folder in the project directory.

Metrics Key Structure​

The structure of the metrics parameters is as follows:

  metrics:
    disabled: false                                  # [optional]
    endpoint: "endpointExample"                      # [optional]
    metricPrefix: "metricsPrefixExample"             # [optional]
KeyDescriptionRequired TypeDefault Value
disabledBy default, metric reporting is set to false. When changed to true, metric reporting is disabled.falsebooleanfalse
endpointBy default, the endpoint responds as api-analytics.falsestring api-analytics
metricPrefixThe naming of the metrics in the response returned by the endpoint can be changed as a prefix.falsestringsystem

Examples​

  • disabled parameter;

    The disabled field is false by default, meaning reporting is enabled by default. Metric reporting can be disabled by changing the disabled value to true.

    image

    Response:

    image

  • endpoint and metricPrefix parameters;

    • By default, the endpoint is defined as api-analytics. It can optionally be changed as follows.

    • By default, metricPrefix is defined as system. It can optionally be changed as follows.

    image

    Response:
    Url: http://localhost:3002/[sampleservice]/api-analytics
    Sample Url: http://localhost:3002/frictionless-symphony/api-analytics
    image