Update Monitoring

kafka_update_monitoring

R Documentation

Updates the monitoring settings for the cluster¶

Description¶

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.

Usage¶

kafka_update_monitoring(ClusterArn, CurrentVersion, EnhancedMonitoring,
  OpenMonitoring, LoggingInfo)

Arguments¶

ClusterArn: [required] The Amazon Resource Name (ARN) that uniquely identifies the cluster.
CurrentVersion: [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: Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
OpenMonitoring: The settings for open monitoring.
LoggingInfo

Value¶

A list with the following syntax:

list(
  ClusterArn = "string",
  ClusterOperationArn = "string"
)

Request syntax¶

svc$update_monitoring(
  ClusterArn = "string",
  CurrentVersion = "string",
  EnhancedMonitoring = "DEFAULT"|"PER_BROKER"|"PER_TOPIC_PER_BROKER"|"PER_TOPIC_PER_PARTITION",
  OpenMonitoring = list(
    Prometheus = list(
      JmxExporter = list(
        EnabledInBroker = TRUE|FALSE
      ),
      NodeExporter = list(
        EnabledInBroker = TRUE|FALSE
      )
    )
  ),
  LoggingInfo = list(
    BrokerLogs = list(
      CloudWatchLogs = list(
        Enabled = TRUE|FALSE,
        LogGroup = "string"
      ),
      Firehose = list(
        DeliveryStream = "string",
        Enabled = TRUE|FALSE
      ),
      S3 = list(
        Bucket = "string",
        Enabled = TRUE|FALSE,
        Prefix = "string"
      )
    )
  )
)