Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Compose per integration metadata.yaml and ops_agent_metadata.yaml files based on the content in ops-agent repo. #814

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions integrations/activemq/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
id: activemq
short_name: ActiveMQ
display_name: Apache ActiveMQ
description: 'The Apache ActiveMQ integration collects storage usage and message metrics.
description: 'The Apache ActiveMQ integration writes logs and collects storage usage
and

Storage metrics include memory and disk usage. Message metrics include number of
message metrics. Storage metrics include memory and disk usage.

waiting messages, average wait time, and expired messages.'
Message metrics include number of waiting messages, average wait time,

and expired messages.'
4 changes: 2 additions & 2 deletions integrations/apache/ops_agent_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,13 @@ platforms:
description: Log entry level
- name: jsonPayload.module
type: string
description: apache module where the log originated
description: Apache module where the log originated
- name: jsonPayload.message
type: string
description: Log message
- name: jsonPayload.errorCode
type: string
description: apache error code
description: Apache error code
- name: jsonPayload.pid
type: string
description: Process ID
Expand Down
12 changes: 8 additions & 4 deletions integrations/couchbase/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
id: couchbase
short_name: couchbase
short_name: Couchbase
display_name: Couchbase
description: The Couchbase integration collects bucket metrics such as operations,
memory usage, and ejections. The integration collects metrics from the Prometheus
server exposed on a node.
description: 'The Couchbase integration collects bucket metrics such as operations,

memory usage, and ejections. The integration collects metrics from the

Prometheus server exposed on a node. The integration also collects Couchbase

general, HTTP access, and cross-datacenter ("goxdcr") logs.'
16 changes: 4 additions & 12 deletions integrations/couchbase/ops_agent_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,16 @@ platforms:
description: The name of the module issuing the entry
- name: jsonPayload.source
type: string
description: ''
description: Source where the log originated
- name: jsonPayload.type
type: string
description: ''
description: The type of log
- name: jsonPayload.level
type: string
description: Log entry severity for the couchbase log
- name: severity
type: string
description: ''
- name: timestamp
type: string
description: ''
- name: couchbase_http_access
fields:
- name: httpRequest.remoteIp
Expand Down Expand Up @@ -82,26 +79,21 @@ platforms:
- name: severity
type: string
description: ''
- name: timestamp
type: string
description: ''
- name: couchbase_goxdcr
fields:
- name: jsonPayload.message
type: string
description: Log message
- name: jsonPayload.log_type
type: string
description: ''
description: The name of the component that is issuing the cross-datacenter
log
- name: jsonPayload.level
type: string
description: Log entry severity for the couchbase log
- name: severity
type: string
description: ''
- name: timestamp
type: string
description: ''
default_metrics:
- name: workload.googleapis.com/couchbase.bucket.operation.count
value_type: INT64
Expand Down
8 changes: 4 additions & 4 deletions integrations/couchdb/ops_agent_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ platforms:
fields:
- name: jsonPayload.node
type: string
description: node instance name
description: Node instance name
- name: jsonPayload.path
type: string
description: request path
description: Request path
- name: jsonPayload.remote_user
type: string
description: Authenticated username for the request
- name: jsonPayload.status_message
type: string
description: status code message
description: Status code message
- name: jsonPayload.pid
type: string
description: Process ID
Expand All @@ -39,7 +39,7 @@ platforms:
description: Log message
- name: jsonPayload.host
type: string
description: host instance name
description: Host instance name
- name: jsonPayload.level
type: string
description: Log entry level
Expand Down
4 changes: 2 additions & 2 deletions integrations/dcgm/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
id: dcgm
short_name: NVIDIA DCGM
display_name: NVIDIA DataCenter GPU Manager (DCGM)
description: 'The NVIDIA DataCenter GPU Manager (DCGM) integration collects advanced
display_name: NVIDIA Data Center GPU Manager (DCGM)
description: 'The NVIDIA Data Center GPU Manager (DCGM) integration collects advanced
GPU metrics,

including SM block utilization, Pipe utilization, PCIe and NVLink traffic.'
6 changes: 3 additions & 3 deletions integrations/elasticsearch/ops_agent_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ platforms:
patch: 0
metrics_minimum_supported_version:
major: 2
minor: 32
minor: 21
patch: 0
detections:
- characteristic_log:
Expand All @@ -34,13 +34,13 @@ platforms:
description: The name of the cluster emitting the log record
- name: jsonPayload.cluster.uuid
type: string
description: The uuid of the cluster emitting the log record
description: The UUID of the cluster emitting the log record
- name: jsonPayload.node.name
type: string
description: The name of the node emitting the log record
- name: jsonPayload.node.uuid
type: string
description: The uuid of the node emitting the log record
description: The UUID of the node emitting the log record
- name: jsonPayload.cluster
type: string
description: The cluster emitting the log record
Expand Down
6 changes: 4 additions & 2 deletions integrations/flink/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ id: flink
short_name: Flink
display_name: Apache Flink
description: 'The Apache Flink integration collects client, jobmanager and taskmanager
logs and parses them into a JSON payload.
logs

The result includes fields for source, level, and message.'
and parses them into a JSON payload. The result includes fields for source,

level, and message.'
4 changes: 2 additions & 2 deletions integrations/flink/ops_agent_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ platforms:
fields:
- name: jsonPayload.message
type: string
description: ''
description: Log message, including detailed stacktrace where provided
- name: jsonPayload.source
type: string
description: ''
description: The source Java class of the log entry
- name: jsonPayload.level
type: string
description: Log entry level
Expand Down
5 changes: 5 additions & 0 deletions integrations/jetty/ops_agent_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ platforms:
- name: severity
type: string
description: ''
- name: syslog
fields:
- name: jsonPayload.message
type: string
description: Log message
default_metrics:
- name: workload.googleapis.com/jetty.select.count
value_type: INT64
Expand Down
9 changes: 3 additions & 6 deletions integrations/kafka/ops_agent_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,19 @@ platforms:
fields:
- name: jsonPayload.message
type: string
description: ''
description: Log message, including detailed stacktrace where provided
- name: jsonPayload.source
type: string
description: ''
description: Module and/or thread where the log originated.
- name: jsonPayload.logger
type: string
description: ''
description: Name of the logger where the log originated.
- name: jsonPayload.level
type: string
description: Log entry level
- name: severity
type: string
description: ''
- name: timestamp
type: string
description: ''
default_metrics:
- name: workload.googleapis.com/kafka.isr.operation.count
value_type: INT64
Expand Down
13 changes: 12 additions & 1 deletion integrations/mongodb/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,15 @@ description: 'The MongoDB integration primarily collects database metrics, such

collects logs and parses them into a JSON payload. The result includes fields

for context, component, level, and message.'
for context, component, level, and message.


Note: Metrics for MongoDB are collected on a per-collection level.

A _collection_ is a group of documents and is analogous to a table in

a relational database. A MongoDB integration with a high number of

collections will produce a high volume of metrics, which can have cost

implications.'
3 changes: 2 additions & 1 deletion integrations/mongodb/ops_agent_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ platforms:
fields:
- name: jsonPayload.component
type: string
description: Categorization of the log message. A full list can be found [here](https://docs.mongodb.com/manual/reference/log-messages/#std-label-log-message-components)
description: Categorization of the log message. A full list can be found in
the [MongoDB documentation](https://docs.mongodb.com/manual/reference/log-messages/#std-label-log-message-components).
- name: jsonPayload.ctx
type: string
description: The name of the thread issuing the log statement
Expand Down
2 changes: 1 addition & 1 deletion integrations/mysql/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
id: mysql
short_name: MySQL
display_name: MySQL
description: 'The MySQL/MariaDB integration collects performance metrics related to
description: 'The MySQL integration collects performance metrics related to

InnoDB, the buffer pool, and various other operations. It also collects general,

Expand Down
4 changes: 2 additions & 2 deletions integrations/nginx/ops_agent_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,10 @@ platforms:
description: Original HTTP request (optional)
- name: jsonPayload.pid
type: number
description: Process ID
description: The process ID issuing the log
- name: jsonPayload.tid
type: number
description: Thread ID
description: Thread ID where the log originated
- name: jsonPayload.connection
type: number
description: Connection ID
Expand Down
8 changes: 4 additions & 4 deletions integrations/postgresql/ops_agent_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ platforms:
patch: 0
metrics_minimum_supported_version:
major: 2
minor: 20
minor: 21
patch: 0
detections:
- characteristic_log:
Expand All @@ -28,12 +28,12 @@ platforms:
- name: jsonPayload.tid
type: number
description: Thread ID where the log originated
- name: jsonPayload.role
type: string
description: Authenticated role for the action being logged when relevant
- name: jsonPayload.user
type: string
description: Authenticated user for the action being logged when relevant
- name: jsonPayload.database
type: string
description: Database name for the action being logged when relevant
- name: severity
type: string
description: ''
Expand Down
2 changes: 1 addition & 1 deletion integrations/rabbitmq/ops_agent_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ platforms:
description: The process ID issuing the log
- name: jsonPayload.message
type: string
description: Log message
description: Log message, including detailed stacktrace where provided
- name: jsonPayload.severity
type: string
description: Log entry level
Expand Down
8 changes: 4 additions & 4 deletions integrations/redis/ops_agent_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@ platforms:
description: Log entry level
- name: jsonPayload.message
type: string
description: ''
description: Log message, including detailed stacktrace where provided
- name: jsonPayload.roleChar
type: string
description: redis role character (X, C, S, M)
description: Redis role character (X, C, S, M)
- name: jsonPayload.role
type: string
description: translated from redis role character (sentinel, RDB/AOF_writing_child,
description: Translated from redis role character (sentinel, RDB/AOF_writing_child,
slave, master)
- name: jsonPayload.pid
type: number
description: Process ID
description: The process ID issuing the log
- name: severity
type: string
description: ''
Expand Down
7 changes: 6 additions & 1 deletion integrations/saphana/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
id: saphana
short_name: HANA
display_name: SAP HANA
description: 'This integration is no longer actively supported. Please use the integration "Google Cloud Agent for SAP" instead.'
description: 'The SAP HANA integration collects SAP HANA metrics and logs. The metrics
are

collected by querying relevant monitoring views. This integration writes

structured trace logs.'
2 changes: 1 addition & 1 deletion integrations/solr/ops_agent_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ platforms:
description: Solr collection related to the log
- name: jsonPayload.level
type: string
description: ''
description: Log entry level
- name: jsonPayload.shard
type: string
description: Solr shard related to the log
Expand Down
2 changes: 1 addition & 1 deletion integrations/tomcat/ops_agent_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ platforms:
description: Module of tomcat where the log originated
- name: jsonPayload.source
type: string
description: source of where the log originated
description: Source of where the log originated
- name: jsonPayload.level
type: string
description: Log entry level
Expand Down
4 changes: 2 additions & 2 deletions integrations/varnish/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
id: varnish
short_name: varnish
short_name: Varnish
display_name: Varnish HTTP Cache
description: 'The Varnish integration collects cache and session metrics.

Expand All @@ -9,4 +9,4 @@ description: 'The Varnish integration collects cache and session metrics.

The integration also collects Varnish logs and parses them

into a standardized json payload.'
into a standardized JSON payload.'
8 changes: 5 additions & 3 deletions integrations/vault/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
id: vault
short_name: Vault
display_name: Hashicorp Vault
description: Vault is an identity-based secrets and encryption management system.
This integration collects Vault's audit logs. The integration also collects token,
memory, and storage metrics.
description: 'Vault is an identity-based secrets and encryption management system.

This integration collects Vault''s audit logs. The integration also collects

token, memory, and storage metrics.'
7 changes: 0 additions & 7 deletions integrations/vault/ops_agent_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -136,16 +136,9 @@ platforms:
type: string
description: This is the display name set by the auth method role or explicitly
at secret creation time.
- name: jsonPayload.response.data.display_name
type: string
description: This is the display name set by the auth method role or explicitly
at secret creation time.
- name: jsonPayload.response.data.entity_id
type: string
description: This is a token entity identifier.
- name: timestamp
type: string ([`Timestamp`](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp))
description: Time the request was received
- name: severity
type: string
description: ''
Expand Down
Loading