Method: Aws::Kafka::Client#update_monitoring

Defined in:

lib/aws-sdk-kafka/client.rb

#update_monitoring(params = {}) ⇒ Types::UpdateMonitoringResponse

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.

Examples:

Request syntax with placeholder values

resp = client.update_monitoring({
  cluster_arn: "__string", # required
  current_version: "__string", # required
  enhanced_monitoring: "DEFAULT", # accepts DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, PER_TOPIC_PER_PARTITION
  open_monitoring: {
    prometheus: { # required
      jmx_exporter: {
        enabled_in_broker: false, # required
      },
      node_exporter: {
        enabled_in_broker: false, # required
      },
    },
  },
  logging_info: {
    broker_logs: { # required
      cloud_watch_logs: {
        enabled: false, # required
        log_group: "__string",
      },
      firehose: {
        delivery_stream: "__string",
        enabled: false, # required
      },
      s3: {
        bucket: "__string",
        enabled: false, # required
        prefix: "__string",
      },
    },
  },
})

Response structure

resp.cluster_arn #=> String
resp.cluster_operation_arn #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :cluster_arn (required, String)
• :current_version (required, String) —

  The version of cluster to update from. A successful operation will then generate a new version.

• :enhanced_monitoring (String) —

  Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

• :open_monitoring (Types::OpenMonitoringInfo) —

  The settings for open monitoring.

• :logging_info (Types::LoggingInfo) —

  LoggingInfo details.

Returns:

• (Types::UpdateMonitoringResponse) —

  Returns a response object which responds to the following methods:

  • #cluster_arn => String

  • #cluster_operation_arn => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-kafka/client.rb', line 3225

def update_monitoring(params = {}, options = {})
  req = build_request(:update_monitoring, params)
  req.send_request(options)
end