Kafka / Client / update_monitoring

update_monitoring#

Kafka.Client.update_monitoring(**kwargs)#

Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.

See also: AWS API Documentation

Request Syntax

response = client.update_monitoring(
    ClusterArn='string',
    CurrentVersion='string',
    EnhancedMonitoring='DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
    OpenMonitoring={
        'Prometheus': {
            'JmxExporter': {
                'EnabledInBroker': True|False
            },
            'NodeExporter': {
                'EnabledInBroker': True|False
            }
        }
    },
    LoggingInfo={
        'BrokerLogs': {
            'CloudWatchLogs': {
                'Enabled': True|False,
                'LogGroup': 'string'
            },
            'Firehose': {
                'DeliveryStream': 'string',
                'Enabled': True|False
            },
            'S3': {
                'Bucket': 'string',
                'Enabled': True|False,
                'Prefix': 'string'
            }
        }
    }
)
Parameters:

  • ClusterArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) that uniquely identifies the cluster.

  • CurrentVersion (string) –

    [REQUIRED]

    The version of the MSK cluster to update. Cluster versions aren’t simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

  • EnhancedMonitoring (string) – Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

  • OpenMonitoring (dict) –

    The settings for open monitoring.

    • Prometheus (dict) – [REQUIRED]

      Prometheus settings.

      • JmxExporter (dict) –

        Indicates whether you want to turn on or turn off the JMX Exporter.

        • EnabledInBroker (boolean) – [REQUIRED]

          Indicates whether you want to turn on or turn off the JMX Exporter.

      • NodeExporter (dict) –

        Indicates whether you want to turn on or turn off the Node Exporter.

        • EnabledInBroker (boolean) – [REQUIRED]

          Indicates whether you want to turn on or turn off the Node Exporter.

  • LoggingInfo (dict) –

    • BrokerLogs (dict) – [REQUIRED]

      • CloudWatchLogs (dict) –

        • Enabled (boolean) – [REQUIRED]

        • LogGroup (string) –

      • Firehose (dict) –

        • DeliveryStream (string) –

        • Enabled (boolean) – [REQUIRED]

      • S3 (dict) –

        • Bucket (string) –

        • Enabled (boolean) – [REQUIRED]

        • Prefix (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ClusterArn': 'string',
    'ClusterOperationArn': 'string'
}

Response Structure

  • (dict) –

    HTTP Status Code 200: OK.

    • ClusterArn (string) –

      The Amazon Resource Name (ARN) of the cluster.

    • ClusterOperationArn (string) –

      The Amazon Resource Name (ARN) of the cluster operation.

Exceptions

  • Kafka.Client.exceptions.ServiceUnavailableException

  • Kafka.Client.exceptions.BadRequestException

  • Kafka.Client.exceptions.UnauthorizedException

  • Kafka.Client.exceptions.InternalServerErrorException

  • Kafka.Client.exceptions.ForbiddenException