Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 2.63 KB

File metadata and controls

32 lines (23 loc) · 2.63 KB

HttpEndpointRule

Specify custom rule configuration apart from Instana predefined rules. This rule has the highest precedence. This is only available for HTTP endpoints.

Properties

Name Type Description Notes
enabled bool Set this flag to `true` if custom rule configurations has to be considered. [optional]
path_segments List[HttpPathSegmentMatchingRule] A list of path segment matching rules, each defining how a segment of the HTTP path should be matched. Each object in this array represents a segment rule, allowing for fixed segments, dynamic parameters, wildcards, or unsupported segments. UNSUPPORTED: A path segment that is not recognized by the system. FIXED: This type represents a static, unchanging part of the URL path. For example, `/api/{version}/users`, `api` and `users` would be `FIXED` segment. PARAMETER: This type represents a variable part of the URL path, often used to capture specific parameters or IDs that change with each request. For example, `/api/{version}/users`, `version` would be `PARAMETER` segment. `version` can be `v1`, `v2`, `v3` etc. MATCH_ALL: This type represents a wildcard, capturing all remaining segments from this point onward in the URL path. For example, `/api/{version}/users/*` — Matches all paths like `/api/v1/users/123`. `/api/v3/users/456` etc.
test_cases List[str] To validate whether the the defined custom endpoint rule configuration is working as expected. For example, given a query `/api/*/{version}`, the following test case `/api/anyName/123` will match, while `/otherApi/anyName/123` will not. [optional]

Example

from instana_client.models.http_endpoint_rule import HttpEndpointRule

# TODO update the JSON string below
json = "{}"
# create an instance of HttpEndpointRule from a JSON string
http_endpoint_rule_instance = HttpEndpointRule.from_json(json)
# print the JSON string representation of the object
print(HttpEndpointRule.to_json())

# convert the object into a dict
http_endpoint_rule_dict = http_endpoint_rule_instance.to_dict()
# create an instance of HttpEndpointRule from a dict
http_endpoint_rule_from_dict = HttpEndpointRule.from_dict(http_endpoint_rule_dict)

[Back to Model list] [Back to API list] [Back to README]