Skip to main content
PUT
/
api
/
v1
/
config
/
trace-tail-sampling-rules
cURL
curl --request PUT \
  --url https://{tenant}.chronosphere.io/api/v1/config/trace-tail-sampling-rules \
  --header 'API-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "create_if_missing": true,
  "dry_run": true,
  "trace_tail_sampling_rules": {
    "default_sample_rate": {
      "enabled": true,
      "sample_rate": 123
    },
    "rules": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "filter": {
          "scope_filter": {
            "span_scopes": [
              {
                "duration": {
                  "max_secs": 123,
                  "min_secs": 123
                },
                "error": {
                  "value": true
                },
                "is_root_span": {
                  "value": true
                },
                "operation": {
                  "in_values": [
                    "<string>"
                  ],
                  "value": "<string>"
                },
                "parent_operation": {
                  "in_values": [
                    "<string>"
                  ],
                  "value": "<string>"
                },
                "parent_service": {
                  "in_values": [
                    "<string>"
                  ],
                  "value": "<string>"
                },
                "service": {
                  "in_values": [
                    "<string>"
                  ],
                  "value": "<string>"
                },
                "span_count": {
                  "max": 123,
                  "min": 123
                },
                "tags": [
                  {
                    "key": "<string>",
                    "numeric_value": {
                      "value": 123
                    },
                    "value": {
                      "in_values": [
                        "<string>"
                      ],
                      "value": "<string>"
                    }
                  }
                ]
              }
            ]
          },
          "span": [
            {
              "duration": {
                "max_secs": 123,
                "min_secs": 123
              },
              "error": {
                "value": true
              },
              "is_root_span": {
                "value": true
              },
              "operation": {
                "in_values": [
                  "<string>"
                ],
                "value": "<string>"
              },
              "parent_operation": {
                "in_values": [
                  "<string>"
                ],
                "value": "<string>"
              },
              "parent_service": {
                "in_values": [
                  "<string>"
                ],
                "value": "<string>"
              },
              "service": {
                "in_values": [
                  "<string>"
                ],
                "value": "<string>"
              },
              "span_count": {
                "max": 123,
                "min": 123
              },
              "tags": [
                {
                  "key": "<string>",
                  "numeric_value": {
                    "value": 123
                  },
                  "value": {
                    "in_values": [
                      "<string>"
                    ],
                    "value": "<string>"
                  }
                }
              ]
            }
          ],
          "trace": {
            "duration": {
              "max_secs": 123,
              "min_secs": 123
            },
            "error": {
              "value": true
            }
          }
        },
        "name": "<string>",
        "sample_rate": 123,
        "system_name": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}
'
{
  "trace_tail_sampling_rules": {
    "created_at": "2023-11-07T05:31:56Z",
    "default_sample_rate": {
      "enabled": true,
      "sample_rate": 123
    },
    "rules": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "filter": {
          "scope_filter": {
            "span_scopes": [
              {
                "duration": {
                  "max_secs": 123,
                  "min_secs": 123
                },
                "error": {
                  "value": true
                },
                "is_root_span": {
                  "value": true
                },
                "operation": {
                  "in_values": [
                    "<string>"
                  ],
                  "value": "<string>"
                },
                "parent_operation": {
                  "in_values": [
                    "<string>"
                  ],
                  "value": "<string>"
                },
                "parent_service": {
                  "in_values": [
                    "<string>"
                  ],
                  "value": "<string>"
                },
                "service": {
                  "in_values": [
                    "<string>"
                  ],
                  "value": "<string>"
                },
                "span_count": {
                  "max": 123,
                  "min": 123
                },
                "tags": [
                  {
                    "key": "<string>",
                    "numeric_value": {
                      "value": 123
                    },
                    "value": {
                      "in_values": [
                        "<string>"
                      ],
                      "value": "<string>"
                    }
                  }
                ]
              }
            ]
          },
          "span": [
            {
              "duration": {
                "max_secs": 123,
                "min_secs": 123
              },
              "error": {
                "value": true
              },
              "is_root_span": {
                "value": true
              },
              "operation": {
                "in_values": [
                  "<string>"
                ],
                "value": "<string>"
              },
              "parent_operation": {
                "in_values": [
                  "<string>"
                ],
                "value": "<string>"
              },
              "parent_service": {
                "in_values": [
                  "<string>"
                ],
                "value": "<string>"
              },
              "service": {
                "in_values": [
                  "<string>"
                ],
                "value": "<string>"
              },
              "span_count": {
                "max": 123,
                "min": 123
              },
              "tags": [
                {
                  "key": "<string>",
                  "numeric_value": {
                    "value": 123
                  },
                  "value": {
                    "in_values": [
                      "<string>"
                    ],
                    "value": "<string>"
                  }
                }
              ]
            }
          ],
          "trace": {
            "duration": {
              "max_secs": 123,
              "min_secs": 123
            },
            "error": {
              "value": true
            }
          }
        },
        "name": "<string>",
        "sample_rate": 123,
        "system_name": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.chronosphere.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
API-Token
string
header
required

Chronosphere API token

Body

application/json
​
create_if_missing
boolean

If true, the TraceTailSamplingRules will be created if it does not already exist. If false, an error will be returned if the TraceTailSamplingRules does not already exist.

​
dry_run
boolean

If true, validates the specified configuration without creating or updating the TraceTailSamplingRules. If the specified configuration is valid, the endpoint returns a partial response without the TraceTailSamplingRules. If the specified configuration is invalid, the endpoint returns an error.

​
trace_tail_sampling_rules
object

The TraceTailSamplingRules to update.

Response

A successful response containing the updated TraceTailSamplingRules.

​
trace_tail_sampling_rules
object

Root object containing all tail sampling rules (for a tenant).