AppRunner / Client / create_observability_configuration

create_observability_configuration#

AppRunner.Client.create_observability_configuration(**kwargs)#

Create an App Runner observability configuration resource. App Runner requires this resource when you create or update App Runner services and you want to enable non-default observability features. You can share an observability configuration across multiple services.

Create multiple revisions of a configuration by calling this action multiple times using the same ObservabilityConfigurationName. The call returns incremental ObservabilityConfigurationRevision values. When you create a service and configure an observability configuration resource, the service uses the latest active revision of the observability configuration by default. You can optionally configure the service to use a specific revision.

The observability configuration resource is designed to configure multiple features (currently one feature, tracing). This action takes optional parameters that describe the configuration of these features (currently one parameter, TraceConfiguration). If you don’t specify a feature parameter, App Runner doesn’t enable the feature.

See also: AWS API Documentation

Request Syntax

response = client.create_observability_configuration(
    ObservabilityConfigurationName='string',
    TraceConfiguration={
        'Vendor': 'AWSXRAY'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ObservabilityConfigurationName (string) –

    [REQUIRED]

    A name for the observability configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.

    Note

    The name DefaultConfiguration is reserved. You can’t use it to create a new observability configuration, and you can’t create a revision of it.

    When you want to use your own observability configuration for your App Runner service, create a configuration with a different name, and then provide it when you create or update your service.

  • TraceConfiguration (dict) –

    The configuration of the tracing feature within this observability configuration. If you don’t specify it, App Runner doesn’t enable tracing.

    • Vendor (string) – [REQUIRED]

      The implementation provider chosen for tracing App Runner services.

  • Tags (list) –

    A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.

    • (dict) –

      Describes a tag that is applied to an App Runner resource. A tag is a metadata item consisting of a key-value pair.

      • Key (string) –

        The key of the tag.

      • Value (string) –

        The value of the tag.

Return type:

dict

Returns:

Response Syntax

{
    'ObservabilityConfiguration': {
        'ObservabilityConfigurationArn': 'string',
        'ObservabilityConfigurationName': 'string',
        'TraceConfiguration': {
            'Vendor': 'AWSXRAY'
        },
        'ObservabilityConfigurationRevision': 123,
        'Latest': True|False,
        'Status': 'ACTIVE'|'INACTIVE',
        'CreatedAt': datetime(2015, 1, 1),
        'DeletedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • ObservabilityConfiguration (dict) –

      A description of the App Runner observability configuration that’s created by this request.

      • ObservabilityConfigurationArn (string) –

        The Amazon Resource Name (ARN) of this observability configuration.

      • ObservabilityConfigurationName (string) –

        The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.

      • TraceConfiguration (dict) –

        The configuration of the tracing feature within this observability configuration. If not specified, tracing isn’t enabled.

        • Vendor (string) –

          The implementation provider chosen for tracing App Runner services.

      • ObservabilityConfigurationRevision (integer) –

        The revision of this observability configuration. It’s unique among all the active configurations ( "Status": "ACTIVE") that share the same ObservabilityConfigurationName.

      • Latest (boolean) –

        It’s set to true for the configuration with the highest Revision among all configurations that share the same ObservabilityConfigurationName. It’s set to false otherwise.

      • Status (string) –

        The current state of the observability configuration. If the status of a configuration revision is INACTIVE, it was deleted and can’t be used. Inactive configuration revisions are permanently removed some time after they are deleted.

      • CreatedAt (datetime) –

        The time when the observability configuration was created. It’s in Unix time stamp format.

      • DeletedAt (datetime) –

        The time when the observability configuration was deleted. It’s in Unix time stamp format.

Exceptions