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

Add config spec templates for JMX integrations #5978

Merged
merged 19 commits into from
Mar 6, 2020
Merged
Show file tree
Hide file tree
Changes from 13 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
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
- name: is_jmx
required: true
description: Whether or not this file is a configuration for a JMX integration.
value:
example: true
type: boolean
- name: collect_default_metrics
required: true
description: Whether or not the check should collect all default metrics.
value:
example: true
type: boolean
- name: conf
required: false
multiple: true
AlexandreYang marked this conversation as resolved.
Show resolved Hide resolved
description: |
List of metrics to be collected by the integration
Read http://docs.datadoghq.com/integrations/java/ to learn how to customize it
Agent 5: Customize all your metrics below
Agent 6: The default metrics to be collected are kept in metrics.yaml,
but you can still add your own metrics here
value:
example:
- include:
bean: <BEAN_NAME>
attribute:
MyAttribute:
alias: my.metric.name
metric_type: gauge

AlexandreYang marked this conversation as resolved.
Show resolved Hide resolved
type: array
items:
type: object
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
- name: host
required: true
description: JMX hostname to connect to.
value:
example: localhost
type: string

- name: port
required: true
description: JMX port to connect to.
value:
example: 8686
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this standard? If not, let's not put example

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

type: integer

- name: user
description: User to use when connecting to JMX.
value:
example: <USERNAME>
AlexandreYang marked this conversation as resolved.
Show resolved Hide resolved
type: string

- name: password
description: Password to use when connecting to JMX.
value:
example: <PASSWORD>
AlexandreYang marked this conversation as resolved.
Show resolved Hide resolved
type: string

- name: process_name_regex
description: |
Instead of specifying a host, and port. The agent can connect using the attach api.
This requires the JDK to be installed and the path to tools.jar to be set below.
Note: It needs to be set when process_name_regex parameter is set
e.g. .*process_name.*
value:
type: string

- name: tools_jar_path
description: |
Path to the tool.jar file to use with `process_name_regex` parameter.
e.g. /usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar
value:
type: string

- name: name
description: Set your instance name that will be used as `instance` tag.
value:
type: string

- name: java_bin_path
description: "`java_bin_path` should be set if the agent cannot find your java executable"
value:
type: string

- name: java_options
description: |
List of Java JVM options.
e.g. "-Xmx200m -Xms50m"
AlexandreYang marked this conversation as resolved.
Show resolved Hide resolved
value:
type: string

- name: trust_store_path
description: |
Path to your trusted store.
`trust_store_path` should be set if ssl is enabled.
value:
type: string

- name: trust_store_password
description: |
Password for your TrustStore.jks file.
`trust_store_password` should be set if ssl is enabled.
value:
type: string

- name: key_store_path
description: |
Path to your key store.
`key_store_path` should be set if client authentication is enabled on the target JVM.
value:
type: string

- name: key_store_password
description: |
Password to your key store.
`key_store_password` should be set if client authentication is enabled on the target JVM.
value:
type: string

- name: rmi_registry_ssl
description: Whether or not the agent should connect to the rmi registry using ssl.
value:
example: false
type: boolean