instana-client 1.0.0__py3-none-any.whl → 1.0.3__py3-none-any.whl

instana_client/api/application_analyze_api.py

@@ -3,9 +3,9 @@
 """
     Instana REST API documentation
 
-    Searching for answers and best pratices? Check our [IBM Instana Community](https://community.ibm.com/community/user/aiops/communities/community-home?CommunityKey=58f324a3-3104-41be-9510-5b7c413cc48f).  ## Overview The Instana REST API provides programmatic access to the Instana platform. It can be used to retrieve data available through the Instana UI Dashboard -- metrics, events, traces, etc -- and also to automate configuration tasks such as user management.  ### Navigating the API documentation The API endpoints are grouped by product area and functionality. This generally maps to how our UI Dashboard is organized, hopefully making it easier to locate which endpoints you'd use to fetch the data you see visualized in our UI. The [UI sections](https://www.ibm.com/docs/en/instana-observability/current?topic=working-user-interface#navigation-menu) include: - Websites & Mobile Apps - Applications - Infrastructure - Synthetic Monitoring - Events - Automation - Service Levels - Settings - etc  ### Rate Limiting A rate limit is applied to API usage. Up to 5,000 calls per hour can be made. How many remaining calls can be made and when this call limit resets, can inspected via three headers that are part of the responses of the API server.  - **X-RateLimit-Limit:** Shows the maximum number of calls that may be executed per hour. - **X-RateLimit-Remaining:** How many calls may still be executed within the current hour. - **X-RateLimit-Reset:** Time when the remaining calls will be reset to the limit. For compatibility reasons with other rate limited APIs, this date is not the date in milliseconds, but instead in seconds since 1970-01-01T00:00:00+00:00.  ### Further Reading We provide additional documentation for our REST API in our [product documentation](https://www.ibm.com/docs/en/instana-observability/current?topic=apis-web-rest-api). Here you'll also find some common queries for retrieving data and configuring Instana.  ## Getting Started with the REST API  ### API base URL The base URL for an specific instance of Instana can be determined using the tenant and unit information. - `base`: This is the base URL of a tenant unit, e.g. `https://test-example.instana.io`. This is the same URL that is used to access the Instana user interface. - `apiToken`: Requests against the Instana API require valid API tokens. An initial API token can be generated via the Instana user interface. Any additional API tokens can be generated via the API itself.  ### Curl Example Here is an Example to use the REST API with Curl. First lets get all the available metrics with possible aggregations with a GET call.  ```bash curl --request GET \\   --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \\   --header 'authorization: apiToken xxxxxxxxxxxxxxxx' ```  Next we can get every call grouped by the endpoint name that has an error count greater then zero. As a metric we could get the mean error rate for example.  ```bash curl --request POST \\   --url https://test-instana.instana.io/api/application-monitoring/analyze/call-groups \\   --header 'authorization: apiToken xxxxxxxxxxxxxxxx' \\   --header 'content-type: application/json' \\   --data '{   \"group\":{       \"groupbyTag\":\"endpoint.name\"   },   \"tagFilters\":[    {     \"name\":\"call.error.count\",     \"value\":\"0\",     \"operator\":\"GREATER_THAN\"    }   ],   \"metrics\":[    {     \"metric\":\"errors\",     \"aggregation\":\"MEAN\"    }   ]   }' ```  ### Generating REST API clients  The API is specified using the [OpenAPI v3](https://github.com/OAI/OpenAPI-Specification) (previously known as Swagger) format. You can download the current specification at our [GitHub API documentation](https://instana.github.io/openapi/openapi.yaml).  OpenAPI tries to solve the issue of ever-evolving APIs and clients lagging behind. Please make sure that you always use the latest version of the generator, as a number of improvements are regularly made. To generate a client library for your language, you can use the [OpenAPI client generators](https://github.com/OpenAPITools/openapi-generator).  #### Go For example, to generate a client library for Go to interact with our backend, you can use the following script; mind replacing the values of the `UNIT_NAME` and `TENANT_NAME` environment variables using those for your tenant unit:  ```bash #!/bin/bash  ### This script assumes you have the `java` and `wget` commands on the path  export UNIT_NAME='myunit' # for example: prod export TENANT_NAME='mytenant' # for example: awesomecompany  //Download the generator to your current working directory: wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar -O openapi-generator-cli.jar --server-variables \"tenant=${TENANT_NAME},unit=${UNIT_NAME}\"  //generate a client library that you can vendor into your repository java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g go \\     -o pkg/instana/openapi \\     --skip-validate-spec  //(optional) format the Go code according to the Go code standard gofmt -s -w pkg/instana/openapi ```  The generated clients contain comprehensive READMEs, and you can start right away using the client from the example above:  ```go import instana \"./pkg/instana/openapi\"  // readTags will read all available application monitoring tags along with their type and category func readTags() {  configuration := instana.NewConfiguration()  configuration.Host = \"tenant-unit.instana.io\"  configuration.BasePath = \"https://tenant-unit.instana.io\"   client := instana.NewAPIClient(configuration)  auth := context.WithValue(context.Background(), instana.ContextAPIKey, instana.APIKey{   Key:    apiKey,   Prefix: \"apiToken\",  })   tags, _, err := client.ApplicationCatalogApi.GetApplicationTagCatalog(auth)  if err != nil {   fmt.Fatalf(\"Error calling the API, aborting.\")  }   for _, tag := range tags {   fmt.Printf(\"%s (%s): %s\\n\", tag.Category, tag.Type, tag.Name)  } } ```  #### Java Follow the instructions provided in the official documentation from [OpenAPI Tools](https://github.com/OpenAPITools) to download the [openapi-generator-cli.jar](https://github.com/OpenAPITools/openapi-generator?tab=readme-ov-file#13---download-jar).  Depending on your environment, use one of the following java http client implementations which will create a valid client for our OpenAPI specification: ``` //Nativ Java HTTP Client java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec  -p dateLibrary=java8 --library native  //Spring WebClient java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec  -p dateLibrary=java8,hideGenerationTimestamp=true --library webclient  //Spring RestTemplate java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec  -p dateLibrary=java8,hideGenerationTimestamp=true --library resttemplate  ``` 
+    Documentation for INSTANA REST API
 
-    The version of the OpenAPI document: 1.291.1002
+    The version of the OpenAPI document: 1.309.1268
     Contact: support@instana.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -22,7 +22,6 @@ from typing import List, Optional
 from typing_extensions import Annotated
 from instana_client.models.backend_trace_reference import BackendTraceReference
 from instana_client.models.call_groups_result import CallGroupsResult
-from instana_client.models.full_trace import FullTrace
 from instana_client.models.get_call_groups import GetCallGroups
 from instana_client.models.get_trace_groups import GetTraceGroups
 from instana_client.models.get_traces import GetTraces
@@ -69,6 +68,7 @@ class ApplicationAnalyzeApi:
     ) -> TraceActivityTreeNodeDetails:
         """Get call detail
 
+        Use this API endpoint to retrieve a vast information about a call present in a trace.  For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param trace_id: (required)
         :type trace_id: str
@@ -139,6 +139,7 @@ class ApplicationAnalyzeApi:
     ) -> ApiResponse[TraceActivityTreeNodeDetails]:
         """Get call detail
 
+        Use this API endpoint to retrieve a vast information about a call present in a trace.  For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param trace_id: (required)
         :type trace_id: str
@@ -209,6 +210,7 @@ class ApplicationAnalyzeApi:
     ) -> RESTResponseType:
         """Get call detail
 
+        Use this API endpoint to retrieve a vast information about a call present in a trace.  For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param trace_id: (required)
         :type trace_id: str
@@ -342,7 +344,7 @@ class ApplicationAnalyzeApi:
     ) -> CallGroupsResult:
         """Get grouped call metrics
 
-        This endpoint retrieves the metrics for calls.    ## Deprecated Parameters  **tagFilters:** The list of tag filters. It is replaced by **tagFilterExpression**, **includeInternal** and **includeSynthetic**.
+         For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param fill_time_series: If enabled, fill the missing data points in the metric result with timestamp and value 0.
         :type fill_time_series: bool
@@ -413,7 +415,7 @@ class ApplicationAnalyzeApi:
     ) -> ApiResponse[CallGroupsResult]:
         """Get grouped call metrics
 
-        This endpoint retrieves the metrics for calls.    ## Deprecated Parameters  **tagFilters:** The list of tag filters. It is replaced by **tagFilterExpression**, **includeInternal** and **includeSynthetic**.
+         For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param fill_time_series: If enabled, fill the missing data points in the metric result with timestamp and value 0.
         :type fill_time_series: bool
@@ -484,7 +486,7 @@ class ApplicationAnalyzeApi:
     ) -> RESTResponseType:
         """Get grouped call metrics
 
-        This endpoint retrieves the metrics for calls.    ## Deprecated Parameters  **tagFilters:** The list of tag filters. It is replaced by **tagFilterExpression**, **includeInternal** and **includeSynthetic**.
+         For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param fill_time_series: If enabled, fill the missing data points in the metric result with timestamp and value 0.
         :type fill_time_series: bool
@@ -632,7 +634,7 @@ class ApplicationAnalyzeApi:
     ) -> List[BackendTraceReference]:
         """Resolve Trace IDs from Monitoring Beacons.
 
-        Resolves backend trace IDs using correlation IDs from website and mobile app monitoring beacons.
+        Resolves backend trace IDs using correlation IDs from website and mobile app monitoring beacons. For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param correlation_id: Here, the `backendTraceId` is typically used which can be obtained from the `Get all beacons` API endpoint for website and mobile app monitoring. For XHR, fetch, or HTTP beacons, the `beaconId` retrieved from the same API endpoint can also serve as the `correlationId`.  (required)
         :type correlation_id: str
@@ -699,7 +701,7 @@ class ApplicationAnalyzeApi:
     ) -> ApiResponse[List[BackendTraceReference]]:
         """Resolve Trace IDs from Monitoring Beacons.
 
-        Resolves backend trace IDs using correlation IDs from website and mobile app monitoring beacons.
+        Resolves backend trace IDs using correlation IDs from website and mobile app monitoring beacons. For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param correlation_id: Here, the `backendTraceId` is typically used which can be obtained from the `Get all beacons` API endpoint for website and mobile app monitoring. For XHR, fetch, or HTTP beacons, the `beaconId` retrieved from the same API endpoint can also serve as the `correlationId`.  (required)
         :type correlation_id: str
@@ -766,7 +768,7 @@ class ApplicationAnalyzeApi:
     ) -> RESTResponseType:
         """Resolve Trace IDs from Monitoring Beacons.
 
-        Resolves backend trace IDs using correlation IDs from website and mobile app monitoring beacons.
+        Resolves backend trace IDs using correlation IDs from website and mobile app monitoring beacons. For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param correlation_id: Here, the `backendTraceId` is typically used which can be obtained from the `Get all beacons` API endpoint for website and mobile app monitoring. For XHR, fetch, or HTTP beacons, the `beaconId` retrieved from the same API endpoint can also serve as the `correlationId`.  (required)
         :type correlation_id: str
@@ -876,270 +878,6 @@ class ApplicationAnalyzeApi:
 
 
 
-    @validate_call
-    def get_trace(
-        self,
-        id: StrictStr,
-        _request_timeout: Union[
-            None,
-            Annotated[StrictFloat, Field(gt=0)],
-            Tuple[
-                Annotated[StrictFloat, Field(gt=0)],
-                Annotated[StrictFloat, Field(gt=0)]
-            ]
-        ] = None,
-        _request_auth: Optional[Dict[StrictStr, Any]] = None,
-        _content_type: Optional[StrictStr] = None,
-        _headers: Optional[Dict[StrictStr, Any]] = None,
-        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> FullTrace:
-        """(Deprecated) Get trace detail
-
-        Replaced by /api/application-monitoring/v2/analyze/traces/{id}
-
-        :param id: (required)
-        :type id: str
-        :param _request_timeout: timeout setting for this request. If one
-                                 number provided, it will be total request
-                                 timeout. It can also be a pair (tuple) of
-                                 (connection, read) timeouts.
-        :type _request_timeout: int, tuple(int, int), optional
-        :param _request_auth: set to override the auth_settings for an a single
-                              request; this effectively ignores the
-                              authentication in the spec for a single request.
-        :type _request_auth: dict, optional
-        :param _content_type: force content-type for the request.
-        :type _content_type: str, Optional
-        :param _headers: set to override the headers for a single
-                         request; this effectively ignores the headers
-                         in the spec for a single request.
-        :type _headers: dict, optional
-        :param _host_index: set to override the host_index for a single
-                            request; this effectively ignores the host_index
-                            in the spec for a single request.
-        :type _host_index: int, optional
-        :return: Returns the result object.
-        """ # noqa: E501
-        warnings.warn("GET /api/application-monitoring/analyze/traces/{id} is deprecated.", DeprecationWarning)
-
-        _param = self._get_trace_serialize(
-            id=id,
-            _request_auth=_request_auth,
-            _content_type=_content_type,
-            _headers=_headers,
-            _host_index=_host_index
-        )
-
-        _response_types_map: Dict[str, Optional[str]] = {
-            '200': "FullTrace",
-        }
-        response_data = self.api_client.call_api(
-            *_param,
-            _request_timeout=_request_timeout
-        )
-        response_data.read()
-        return self.api_client.response_deserialize(
-            response_data=response_data,
-            response_types_map=_response_types_map,
-        ).data
-
-
-    @validate_call
-    def get_trace_with_http_info(
-        self,
-        id: StrictStr,
-        _request_timeout: Union[
-            None,
-            Annotated[StrictFloat, Field(gt=0)],
-            Tuple[
-                Annotated[StrictFloat, Field(gt=0)],
-                Annotated[StrictFloat, Field(gt=0)]
-            ]
-        ] = None,
-        _request_auth: Optional[Dict[StrictStr, Any]] = None,
-        _content_type: Optional[StrictStr] = None,
-        _headers: Optional[Dict[StrictStr, Any]] = None,
-        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[FullTrace]:
-        """(Deprecated) Get trace detail
-
-        Replaced by /api/application-monitoring/v2/analyze/traces/{id}
-
-        :param id: (required)
-        :type id: str
-        :param _request_timeout: timeout setting for this request. If one
-                                 number provided, it will be total request
-                                 timeout. It can also be a pair (tuple) of
-                                 (connection, read) timeouts.
-        :type _request_timeout: int, tuple(int, int), optional
-        :param _request_auth: set to override the auth_settings for an a single
-                              request; this effectively ignores the
-                              authentication in the spec for a single request.
-        :type _request_auth: dict, optional
-        :param _content_type: force content-type for the request.
-        :type _content_type: str, Optional
-        :param _headers: set to override the headers for a single
-                         request; this effectively ignores the headers
-                         in the spec for a single request.
-        :type _headers: dict, optional
-        :param _host_index: set to override the host_index for a single
-                            request; this effectively ignores the host_index
-                            in the spec for a single request.
-        :type _host_index: int, optional
-        :return: Returns the result object.
-        """ # noqa: E501
-        warnings.warn("GET /api/application-monitoring/analyze/traces/{id} is deprecated.", DeprecationWarning)
-
-        _param = self._get_trace_serialize(
-            id=id,
-            _request_auth=_request_auth,
-            _content_type=_content_type,
-            _headers=_headers,
-            _host_index=_host_index
-        )
-
-        _response_types_map: Dict[str, Optional[str]] = {
-            '200': "FullTrace",
-        }
-        response_data = self.api_client.call_api(
-            *_param,
-            _request_timeout=_request_timeout
-        )
-        response_data.read()
-        return self.api_client.response_deserialize(
-            response_data=response_data,
-            response_types_map=_response_types_map,
-        )
-
-
-    @validate_call
-    def get_trace_without_preload_content(
-        self,
-        id: StrictStr,
-        _request_timeout: Union[
-            None,
-            Annotated[StrictFloat, Field(gt=0)],
-            Tuple[
-                Annotated[StrictFloat, Field(gt=0)],
-                Annotated[StrictFloat, Field(gt=0)]
-            ]
-        ] = None,
-        _request_auth: Optional[Dict[StrictStr, Any]] = None,
-        _content_type: Optional[StrictStr] = None,
-        _headers: Optional[Dict[StrictStr, Any]] = None,
-        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> RESTResponseType:
-        """(Deprecated) Get trace detail
-
-        Replaced by /api/application-monitoring/v2/analyze/traces/{id}
-
-        :param id: (required)
-        :type id: str
-        :param _request_timeout: timeout setting for this request. If one
-                                 number provided, it will be total request
-                                 timeout. It can also be a pair (tuple) of
-                                 (connection, read) timeouts.
-        :type _request_timeout: int, tuple(int, int), optional
-        :param _request_auth: set to override the auth_settings for an a single
-                              request; this effectively ignores the
-                              authentication in the spec for a single request.
-        :type _request_auth: dict, optional
-        :param _content_type: force content-type for the request.
-        :type _content_type: str, Optional
-        :param _headers: set to override the headers for a single
-                         request; this effectively ignores the headers
-                         in the spec for a single request.
-        :type _headers: dict, optional
-        :param _host_index: set to override the host_index for a single
-                            request; this effectively ignores the host_index
-                            in the spec for a single request.
-        :type _host_index: int, optional
-        :return: Returns the result object.
-        """ # noqa: E501
-        warnings.warn("GET /api/application-monitoring/analyze/traces/{id} is deprecated.", DeprecationWarning)
-
-        _param = self._get_trace_serialize(
-            id=id,
-            _request_auth=_request_auth,
-            _content_type=_content_type,
-            _headers=_headers,
-            _host_index=_host_index
-        )
-
-        _response_types_map: Dict[str, Optional[str]] = {
-            '200': "FullTrace",
-        }
-        response_data = self.api_client.call_api(
-            *_param,
-            _request_timeout=_request_timeout
-        )
-        return response_data.response
-
-
-    def _get_trace_serialize(
-        self,
-        id,
-        _request_auth,
-        _content_type,
-        _headers,
-        _host_index,
-    ) -> RequestSerialized:
-
-        _host = None
-
-        _collection_formats: Dict[str, str] = {
-        }
-
-        _path_params: Dict[str, str] = {}
-        _query_params: List[Tuple[str, str]] = []
-        _header_params: Dict[str, Optional[str]] = _headers or {}
-        _form_params: List[Tuple[str, str]] = []
-        _files: Dict[
-            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
-        ] = {}
-        _body_params: Optional[bytes] = None
-
-        # process the path parameters
-        if id is not None:
-            _path_params['id'] = id
-        # process the query parameters
-        # process the header parameters
-        # process the form parameters
-        # process the body parameter
-
-
-        # set the HTTP header `Accept`
-        if 'Accept' not in _header_params:
-            _header_params['Accept'] = self.api_client.select_header_accept(
-                [
-                    'application/json'
-                ]
-            )
-
-
-        # authentication setting
-        _auth_settings: List[str] = [
-            'ApiKeyAuth'
-        ]
-
-        return self.api_client.param_serialize(
-            method='GET',
-            resource_path='/api/application-monitoring/analyze/traces/{id}',
-            path_params=_path_params,
-            query_params=_query_params,
-            header_params=_header_params,
-            body=_body_params,
-            post_params=_form_params,
-            files=_files,
-            auth_settings=_auth_settings,
-            collection_formats=_collection_formats,
-            _host=_host,
-            _request_auth=_request_auth
-        )
-
-
-
-
     @validate_call
     def get_trace_download(
         self,
@@ -1162,7 +900,7 @@ class ApplicationAnalyzeApi:
     ) -> TraceDownloadResult:
         """Get trace detail
 
-         Use this API endpoint if one wants to retrive comprehensive details of a particular trace.
+        Use this API endpoint if one wants to retrive comprehensive details of a particular trace. For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param id: (required)
         :type id: str
@@ -1241,7 +979,7 @@ class ApplicationAnalyzeApi:
     ) -> ApiResponse[TraceDownloadResult]:
         """Get trace detail
 
-         Use this API endpoint if one wants to retrive comprehensive details of a particular trace.
+        Use this API endpoint if one wants to retrive comprehensive details of a particular trace. For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param id: (required)
         :type id: str
@@ -1320,7 +1058,7 @@ class ApplicationAnalyzeApi:
     ) -> RESTResponseType:
         """Get trace detail
 
-         Use this API endpoint if one wants to retrive comprehensive details of a particular trace.
+        Use this API endpoint if one wants to retrive comprehensive details of a particular trace. For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param id: (required)
         :type id: str
@@ -1472,7 +1210,7 @@ class ApplicationAnalyzeApi:
     ) -> TraceGroupsResult:
         """Get grouped trace metrics
 
-        The API endpoint retrieves metrics for traces that are grouped in the endpoint or service name.  The supported `groupbyTag` are `trace.endpoint.name` and `trace.service.name`.  {: note} 
+        In this endpoint, the supported `groupbyTag` are `trace.endpoint.name` and `trace.service.name`.  For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param fill_time_series: If enabled, fill the missing data points in the metric result with timestamp and value 0.
         :type fill_time_series: bool
@@ -1543,7 +1281,7 @@ class ApplicationAnalyzeApi:
     ) -> ApiResponse[TraceGroupsResult]:
         """Get grouped trace metrics
 
-        The API endpoint retrieves metrics for traces that are grouped in the endpoint or service name.  The supported `groupbyTag` are `trace.endpoint.name` and `trace.service.name`.  {: note} 
+        In this endpoint, the supported `groupbyTag` are `trace.endpoint.name` and `trace.service.name`.  For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param fill_time_series: If enabled, fill the missing data points in the metric result with timestamp and value 0.
         :type fill_time_series: bool
@@ -1614,7 +1352,7 @@ class ApplicationAnalyzeApi:
     ) -> RESTResponseType:
         """Get grouped trace metrics
 
-        The API endpoint retrieves metrics for traces that are grouped in the endpoint or service name.  The supported `groupbyTag` are `trace.endpoint.name` and `trace.service.name`.  {: note} 
+        In this endpoint, the supported `groupbyTag` are `trace.endpoint.name` and `trace.service.name`.  For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param fill_time_series: If enabled, fill the missing data points in the metric result with timestamp and value 0.
         :type fill_time_series: bool
@@ -1762,7 +1500,7 @@ class ApplicationAnalyzeApi:
     ) -> TraceResult:
         """Get all traces
 
-        This endpoint retrieves the metrics for traces.    **Manditory Paramters:**    **Optional Paramters:**    **Defaults:**    **Limits:**    **Tips:**  
+         For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param get_traces:
         :type get_traces: GetTraces
@@ -1829,7 +1567,7 @@ class ApplicationAnalyzeApi:
     ) -> ApiResponse[TraceResult]:
         """Get all traces
 
-        This endpoint retrieves the metrics for traces.    **Manditory Paramters:**    **Optional Paramters:**    **Defaults:**    **Limits:**    **Tips:**  
+         For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param get_traces:
         :type get_traces: GetTraces
@@ -1896,7 +1634,7 @@ class ApplicationAnalyzeApi:
     ) -> RESTResponseType:
         """Get all traces
 
-        This endpoint retrieves the metrics for traces.    **Manditory Paramters:**    **Optional Paramters:**    **Defaults:**    **Limits:**    **Tips:**  
+         For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze.
 
         :param get_traces:
         :type get_traces: GetTraces

instana_client/api/application_catalog_api.py

@@ -3,9 +3,9 @@
 """
     Instana REST API documentation
 
-    Searching for answers and best pratices? Check our [IBM Instana Community](https://community.ibm.com/community/user/aiops/communities/community-home?CommunityKey=58f324a3-3104-41be-9510-5b7c413cc48f).  ## Overview The Instana REST API provides programmatic access to the Instana platform. It can be used to retrieve data available through the Instana UI Dashboard -- metrics, events, traces, etc -- and also to automate configuration tasks such as user management.  ### Navigating the API documentation The API endpoints are grouped by product area and functionality. This generally maps to how our UI Dashboard is organized, hopefully making it easier to locate which endpoints you'd use to fetch the data you see visualized in our UI. The [UI sections](https://www.ibm.com/docs/en/instana-observability/current?topic=working-user-interface#navigation-menu) include: - Websites & Mobile Apps - Applications - Infrastructure - Synthetic Monitoring - Events - Automation - Service Levels - Settings - etc  ### Rate Limiting A rate limit is applied to API usage. Up to 5,000 calls per hour can be made. How many remaining calls can be made and when this call limit resets, can inspected via three headers that are part of the responses of the API server.  - **X-RateLimit-Limit:** Shows the maximum number of calls that may be executed per hour. - **X-RateLimit-Remaining:** How many calls may still be executed within the current hour. - **X-RateLimit-Reset:** Time when the remaining calls will be reset to the limit. For compatibility reasons with other rate limited APIs, this date is not the date in milliseconds, but instead in seconds since 1970-01-01T00:00:00+00:00.  ### Further Reading We provide additional documentation for our REST API in our [product documentation](https://www.ibm.com/docs/en/instana-observability/current?topic=apis-web-rest-api). Here you'll also find some common queries for retrieving data and configuring Instana.  ## Getting Started with the REST API  ### API base URL The base URL for an specific instance of Instana can be determined using the tenant and unit information. - `base`: This is the base URL of a tenant unit, e.g. `https://test-example.instana.io`. This is the same URL that is used to access the Instana user interface. - `apiToken`: Requests against the Instana API require valid API tokens. An initial API token can be generated via the Instana user interface. Any additional API tokens can be generated via the API itself.  ### Curl Example Here is an Example to use the REST API with Curl. First lets get all the available metrics with possible aggregations with a GET call.  ```bash curl --request GET \\   --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \\   --header 'authorization: apiToken xxxxxxxxxxxxxxxx' ```  Next we can get every call grouped by the endpoint name that has an error count greater then zero. As a metric we could get the mean error rate for example.  ```bash curl --request POST \\   --url https://test-instana.instana.io/api/application-monitoring/analyze/call-groups \\   --header 'authorization: apiToken xxxxxxxxxxxxxxxx' \\   --header 'content-type: application/json' \\   --data '{   \"group\":{       \"groupbyTag\":\"endpoint.name\"   },   \"tagFilters\":[    {     \"name\":\"call.error.count\",     \"value\":\"0\",     \"operator\":\"GREATER_THAN\"    }   ],   \"metrics\":[    {     \"metric\":\"errors\",     \"aggregation\":\"MEAN\"    }   ]   }' ```  ### Generating REST API clients  The API is specified using the [OpenAPI v3](https://github.com/OAI/OpenAPI-Specification) (previously known as Swagger) format. You can download the current specification at our [GitHub API documentation](https://instana.github.io/openapi/openapi.yaml).  OpenAPI tries to solve the issue of ever-evolving APIs and clients lagging behind. Please make sure that you always use the latest version of the generator, as a number of improvements are regularly made. To generate a client library for your language, you can use the [OpenAPI client generators](https://github.com/OpenAPITools/openapi-generator).  #### Go For example, to generate a client library for Go to interact with our backend, you can use the following script; mind replacing the values of the `UNIT_NAME` and `TENANT_NAME` environment variables using those for your tenant unit:  ```bash #!/bin/bash  ### This script assumes you have the `java` and `wget` commands on the path  export UNIT_NAME='myunit' # for example: prod export TENANT_NAME='mytenant' # for example: awesomecompany  //Download the generator to your current working directory: wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar -O openapi-generator-cli.jar --server-variables \"tenant=${TENANT_NAME},unit=${UNIT_NAME}\"  //generate a client library that you can vendor into your repository java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g go \\     -o pkg/instana/openapi \\     --skip-validate-spec  //(optional) format the Go code according to the Go code standard gofmt -s -w pkg/instana/openapi ```  The generated clients contain comprehensive READMEs, and you can start right away using the client from the example above:  ```go import instana \"./pkg/instana/openapi\"  // readTags will read all available application monitoring tags along with their type and category func readTags() {  configuration := instana.NewConfiguration()  configuration.Host = \"tenant-unit.instana.io\"  configuration.BasePath = \"https://tenant-unit.instana.io\"   client := instana.NewAPIClient(configuration)  auth := context.WithValue(context.Background(), instana.ContextAPIKey, instana.APIKey{   Key:    apiKey,   Prefix: \"apiToken\",  })   tags, _, err := client.ApplicationCatalogApi.GetApplicationTagCatalog(auth)  if err != nil {   fmt.Fatalf(\"Error calling the API, aborting.\")  }   for _, tag := range tags {   fmt.Printf(\"%s (%s): %s\\n\", tag.Category, tag.Type, tag.Name)  } } ```  #### Java Follow the instructions provided in the official documentation from [OpenAPI Tools](https://github.com/OpenAPITools) to download the [openapi-generator-cli.jar](https://github.com/OpenAPITools/openapi-generator?tab=readme-ov-file#13---download-jar).  Depending on your environment, use one of the following java http client implementations which will create a valid client for our OpenAPI specification: ``` //Nativ Java HTTP Client java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec  -p dateLibrary=java8 --library native  //Spring WebClient java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec  -p dateLibrary=java8,hideGenerationTimestamp=true --library webclient  //Spring RestTemplate java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec  -p dateLibrary=java8,hideGenerationTimestamp=true --library resttemplate  ``` 
+    Documentation for INSTANA REST API
 
-    The version of the OpenAPI document: 1.291.1002
+    The version of the OpenAPI document: 1.309.1268
     Contact: support@instana.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -60,7 +60,7 @@ class ApplicationCatalogApi:
     ) -> List[MetricDescription]:
         """Get Metric catalog
 
-        This endpoint retrieves all available metric definitions for application monitoring. 
+         For more information on Application Catalog please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-catalog.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -123,7 +123,7 @@ class ApplicationCatalogApi:
     ) -> ApiResponse[List[MetricDescription]]:
         """Get Metric catalog
 
-        This endpoint retrieves all available metric definitions for application monitoring. 
+         For more information on Application Catalog please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-catalog.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -186,7 +186,7 @@ class ApplicationCatalogApi:
     ) -> RESTResponseType:
         """Get Metric catalog
 
-        This endpoint retrieves all available metric definitions for application monitoring. 
+         For more information on Application Catalog please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-catalog.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -309,7 +309,7 @@ class ApplicationCatalogApi:
     ) -> TagCatalog:
         """Get application tag catalog
 
-        Use this API endpoint to retrieve a list of tags. This API endpoint also shows tags which are grouped together. This grouping also denotes the dimensionality of an event. Eg: `Call` can have 9 attributes. Also these tags have cardinality ranging from low to high which will help in examining broad or narrow patterns during the analysis. Queryable tags are a powerful enabler for slice and dice analysis in `Query Builder`.  `Query Builder` can be found in `Unbounded Analytics`.
+         For more information on Application Catalog please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-catalog.
 
         :param var_from: The start of the timestamp expreseed in Unix epoch time in milliseconds which will fetch list of queryable tags until current timestamp. Eg: `1719875833000` (1 July 2024 23:17:13 GMT) will fetch list of queryable tags from that time till current time. 
         :type var_from: int
@@ -384,7 +384,7 @@ class ApplicationCatalogApi:
     ) -> ApiResponse[TagCatalog]:
         """Get application tag catalog
 
-        Use this API endpoint to retrieve a list of tags. This API endpoint also shows tags which are grouped together. This grouping also denotes the dimensionality of an event. Eg: `Call` can have 9 attributes. Also these tags have cardinality ranging from low to high which will help in examining broad or narrow patterns during the analysis. Queryable tags are a powerful enabler for slice and dice analysis in `Query Builder`.  `Query Builder` can be found in `Unbounded Analytics`.
+         For more information on Application Catalog please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-catalog.
 
         :param var_from: The start of the timestamp expreseed in Unix epoch time in milliseconds which will fetch list of queryable tags until current timestamp. Eg: `1719875833000` (1 July 2024 23:17:13 GMT) will fetch list of queryable tags from that time till current time. 
         :type var_from: int
@@ -459,7 +459,7 @@ class ApplicationCatalogApi:
     ) -> RESTResponseType:
         """Get application tag catalog
 
-        Use this API endpoint to retrieve a list of tags. This API endpoint also shows tags which are grouped together. This grouping also denotes the dimensionality of an event. Eg: `Call` can have 9 attributes. Also these tags have cardinality ranging from low to high which will help in examining broad or narrow patterns during the analysis. Queryable tags are a powerful enabler for slice and dice analysis in `Query Builder`.  `Query Builder` can be found in `Unbounded Analytics`.
+         For more information on Application Catalog please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-catalog.
 
         :param var_from: The start of the timestamp expreseed in Unix epoch time in milliseconds which will fetch list of queryable tags until current timestamp. Eg: `1719875833000` (1 July 2024 23:17:13 GMT) will fetch list of queryable tags from that time till current time. 
         :type var_from: int
@@ -606,7 +606,7 @@ class ApplicationCatalogApi:
     ) -> List[Tag]:
         """(Deprecated) Get application tags
 
-        **Note:** This API Endpoint is deprecated. Use `Get application tag catalog` endpoint instead.  This endpoint retrieves all available tags for your monitored system.  These tags can be used to group metric results. ``` \"group\": {   \"groupbyTag\": \"service.name\" } ```  These tags can be used to filter metric results. ``` \"tagFilters\": [{  \"name\": \"application.name\",  \"operator\": \"EQUALS\",  \"value\": \"example\" }] ``` 
+         For more information on Application Catalog please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-catalog.
 
         :param var_from: The start of the timestamp expreseed in Unix epoch time in milliseconds which will fetch list of queryable tags until current timestamp. Eg: `1719875833000` (1 July 2024 23:17:13 GMT) will fetch list of queryable tags from that time till current time. 
         :type var_from: int
@@ -682,7 +682,7 @@ class ApplicationCatalogApi:
     ) -> ApiResponse[List[Tag]]:
         """(Deprecated) Get application tags
 
-        **Note:** This API Endpoint is deprecated. Use `Get application tag catalog` endpoint instead.  This endpoint retrieves all available tags for your monitored system.  These tags can be used to group metric results. ``` \"group\": {   \"groupbyTag\": \"service.name\" } ```  These tags can be used to filter metric results. ``` \"tagFilters\": [{  \"name\": \"application.name\",  \"operator\": \"EQUALS\",  \"value\": \"example\" }] ``` 
+         For more information on Application Catalog please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-catalog.
 
         :param var_from: The start of the timestamp expreseed in Unix epoch time in milliseconds which will fetch list of queryable tags until current timestamp. Eg: `1719875833000` (1 July 2024 23:17:13 GMT) will fetch list of queryable tags from that time till current time. 
         :type var_from: int
@@ -758,7 +758,7 @@ class ApplicationCatalogApi:
     ) -> RESTResponseType:
         """(Deprecated) Get application tags
 
-        **Note:** This API Endpoint is deprecated. Use `Get application tag catalog` endpoint instead.  This endpoint retrieves all available tags for your monitored system.  These tags can be used to group metric results. ``` \"group\": {   \"groupbyTag\": \"service.name\" } ```  These tags can be used to filter metric results. ``` \"tagFilters\": [{  \"name\": \"application.name\",  \"operator\": \"EQUALS\",  \"value\": \"example\" }] ``` 
+         For more information on Application Catalog please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-catalog.
 
         :param var_from: The start of the timestamp expreseed in Unix epoch time in milliseconds which will fetch list of queryable tags until current timestamp. Eg: `1719875833000` (1 July 2024 23:17:13 GMT) will fetch list of queryable tags from that time till current time. 
         :type var_from: int