Metadata API Reference: Observability Options

Available on: Cloud and Enterprise Edition

Introduction

The API to manage Observability related metadata configurations.

Logs and metrics configuration

These is the set of configurations that governs the metrics and logging output for various debugging and analytics purposes.

set_metrics_config

set_metrics_config is used to add/update logs and metrics configurations.

POST /v1/metadata HTTP/1.1
Content-Type: application/json
X-Hasura-Role: admin
{
    "type": "set_metrics_config",
    "args": {
        "analyze_query_variables": false    
    }
}

Args syntax

Key	Required	Schema	Description
analyze_query_variables	false	boolean	Enables logging of the values of the query variables provided for each request. Default is false.

The corresponding feature documentation for the usage of these configurations can be found here.

remove_metrics_config

remove_metrics_config is used to remove all metrics configurations.

POST /v1/metadata HTTP/1.1
Content-Type: application/json
X-Hasura-Role: admin
{
    "type": "remove_metrics_config",
    "args": {}
}