Skip to content

get_instrumentation_configuration

get_instrumentation_configuration(
    instrumentation_type: InstrumentationType,
    service: str,
    environment: str,
    signal_type: DynamicInstrumentationSignalType,
    location_identifier: LocationIdentifier,
    *,
    config_overrides: Optional[ApplicationSignalsClientConfig] = None,
) -> GetInstrumentationConfigurationResponse

Returns the details of a single instrumentation configuration identified by service, environment, signal type, and location. Use this to audit or display configuration details.

Parameters:

  • instrumentation_type (InstrumentationType) –

    Type of instrumentation configuration (BREAKPOINT or PROBE). Required to identify the configuration to retrieve.

  • service (str) –

    Service name for the instrumentation configuration.

  • environment (str) –

    Environment name for the instrumentation configuration.

  • signal_type (DynamicInstrumentationSignalType) –

    Signal type for the instrumentation configuration.

  • location_identifier (LocationIdentifier) –

    Location identifier - either full code location or a pre-computed hash.

Raises:

Source code in docs_src/capo_application_signals/_services/application_signals.py
def get_instrumentation_configuration(
    self,
    instrumentation_type: "capo_application_signals.types.instrumentation_type.InstrumentationType",
    service: str,
    environment: str,
    signal_type: "capo_application_signals.types.dynamic_instrumentation_signal_type.DynamicInstrumentationSignalType",
    location_identifier: "capo_application_signals.types.location_identifier.LocationIdentifier",
    *,
    config_overrides: Optional[ApplicationSignalsClientConfig] = None,
) -> "capo_application_signals.types.get_instrumentation_configuration_response.GetInstrumentationConfigurationResponse":
    """<p>Returns the details of a single instrumentation configuration identified by service, environment, signal type, and location. Use this to audit or display configuration details.</p>

    Args:
        instrumentation_type: Type of instrumentation configuration (BREAKPOINT or PROBE). Required to identify the configuration to retrieve.
        service: Service name for the instrumentation configuration.
        environment: Environment name for the instrumentation configuration.
        signal_type: Signal type for the instrumentation configuration.
        location_identifier: Location identifier - either full code location or a pre-computed hash.

    Raises:
        capo_application_signals.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource not found.</p>
        capo_application_signals.errors.throttling_exception.ThrottlingException: <p>The request was throttled because of quota limits.</p>
        capo_application_signals.errors.validation_exception.ValidationException: <p>The resource is not valid.</p>
        capo_application_signals.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_application_signals.types.get_instrumentation_configuration_request.GetInstrumentationConfigurationRequest]",
    ) -> OperationResponse[
        "capo_application_signals.types.get_instrumentation_configuration_response.GetInstrumentationConfigurationResponse"
    ]:
        import capo_application_signals._operations.application_signals.get_instrumentation_configuration

        output, http_response = (
            capo_application_signals._operations.application_signals.get_instrumentation_configuration.get_instrumentation_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetInstrumentationConfiguration")
    )
    input_: capo_application_signals.types.get_instrumentation_configuration_request.GetInstrumentationConfigurationRequest = {
        "instrumentation_type": instrumentation_type,
        "service": service,
        "environment": environment,
        "signal_type": signal_type,
        "location_identifier": location_identifier,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output