pubsubbeat.yml

################### Pubsubbeat Configuration Example #########################

############################# Pubsubbeat ######################################

pubsubbeat:
  # The service account or refresh token JSON credentials file to use
  # to authenticate API calls.
  #
  # If you don't specify a credentials file, this Beat will use a
  # strategy called Application Default Credentials (ADC) to find your
  # application's credentials. If your Beat runs on Google Cloud Platform,
  # this strategy is recommended.
  #
  # To learn more about ADC:
  # - https://cloud.google.com/docs/authentication/production
  credentials_file:

  # The GCP project ID with your Pub/Sub topic
  project_id: my-gcp-project

  # The Pub/Sub topic name. You must first create this topic.
  topic: my-topic

  # The Pub/Sub subscription name.
  subscription.name: my-subscription

  # Attempt to create the subscription.
  subscription.create: true # Defaults to true

  # The settings below are used only if the Beat creates the subscription.

  # Whether to retain acknowledged messages. If true, acknowledged messages
  # will not be expunged until they fall out of the RetentionDuration window.
  subscription.retain_acked_messages: false

  # How long to retain messages in backlog, from the time of publish. If
  # retain_acked_messages is true, this duration affects the retention of
  # acknowledged messages, otherwise only unacknowledged messages are retained.
  # Cannot be longer than 7 days or shorter than 10 minutes.
  # Valid time units are "m" and "h". You can also compose them: "2h30m".
  subscription.retention_duration: 168h # Defaults to 7 days

  # How many simultaneous connections the beat will establish to the Pub/Sub endpoint.
  # Pub/Sub streaming pull has a per-subscriber throughput limit,
  # https://cloud.google.com/pubsub/quotas
  # Increasing the pool size will increase the throughput of the beat until
  # a different quota is hit.
  subscription.connection_pool_size: 1

  ### JSON Configuration

  # Whether to decode the Pub/Sub message as a JSON message.
  # If the message is decoded successfully, a "json" field is added to the event with
  # the decoded json object. If the decoding fails, the "message" field includes the
  # plain text message payload.
  json.enabled: false

  # If this setting is enabled, Pubsubbeat adds a "error.message" and "error.key: json" key
  # in case of JSON unmarshaling errors or when a text key is defined in the configuration
  # but cannot be used.
  json.add_error_key: false

#================================ General =====================================

# The name of the shipper that publishes the network data. It can be used to group
# all the transactions sent by a single shipper in the web interface.
#name:

# The tags of the shipper are included in their own field with each
# transaction published.
#tags: ["service-X", "web-tier"]

# Optional fields that you can specify to add additional information to the
# output.
#fields:
#  env: staging


#============================== Dashboards =====================================
# These settings control loading the sample dashboards to the Kibana index. Loading
# the dashboards is disabled by default and can be enabled either by setting the
# options here, or by using the `-setup` CLI flag or the `setup` command.
#setup.dashboards.enabled: false

# The URL from where to download the dashboards archive. By default this URL
# has a value which is computed based on the Beat name and version. For released
# versions, this URL points to the dashboard archive on the artifacts.elastic.co
# website.
#setup.dashboards.url:

#============================== Kibana =====================================

# Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.
# This requires a Kibana endpoint configuration.
setup.kibana:

  # Kibana Host
  # Scheme and port can be left out and will be set to the default (http and 5601)
  # In case you specify and additional path, the scheme is required: http://localhost:5601/path
  # IPv6 addresses should always be defined as: https://[2001:db8::1]:5601
  #host: "localhost:5601"

#============================= Elastic Cloud ==================================

# These settings simplify using pubsubbeat with the Elastic Cloud (https://cloud.elastic.co/).

# The cloud.id setting overwrites the `output.elasticsearch.hosts` and
# `setup.kibana.host` options.
# You can find the `cloud.id` in the Elastic Cloud web UI.
#cloud.id:

# The cloud.auth setting overwrites the `output.elasticsearch.username` and
# `output.elasticsearch.password` settings. The format is `<user>:<pass>`.
#cloud.auth:

#================================ Outputs =====================================

# Configure what output to use when sending the data collected by the beat.

#-------------------------- Elasticsearch output ------------------------------
output.elasticsearch:
  # Array of hosts to connect to.
  hosts: ["localhost:9200"]

  # Optional protocol and basic auth credentials.
  #protocol: "https"
  #username: "elastic"
  #password: "changeme"

#----------------------------- Logstash output --------------------------------
#output.logstash:
  # The Logstash hosts
  #hosts: ["localhost:5044"]

  # Optional SSL. By default is off.
  # List of root certificates for HTTPS server verifications
  #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]

  # Certificate for SSL client authentication
  #ssl.certificate: "/etc/pki/client/cert.pem"

  # Client Certificate Key
  #ssl.key: "/etc/pki/client/cert.key"

#================================ Logging =====================================

# Sets log level. The default log level is info.
# Available log levels are: error, warning, info, debug
#logging.level: debug

# At debug level, you can selectively enable logging only for some components.
# To enable all selectors use ["*"]. Examples of other selectors are "beat",
# "publish", "service".
#logging.selectors: ["*"]

#============================== Xpack Monitoring ===============================
# pubsubbeat can export internal metrics to a central Elasticsearch monitoring
# cluster.  This requires xpack monitoring to be enabled in Elasticsearch.  The
# reporting is disabled by default.

# Set to true to enable the monitoring reporter.
#xpack.monitoring.enabled: false

# Uncomment to send the metrics to Elasticsearch. Most settings from the
# Elasticsearch output are accepted here as well. Any setting that is not set is
# automatically inherited from the Elasticsearch output configuration, so if you
# have the Elasticsearch output configured, you can simply uncomment the
# following line.
#xpack.monitoring.elasticsearch: