Skip to content

Commit

Permalink
Add the Impala integration (#12548)
Browse files Browse the repository at this point in the history
Co-authored-by: Sarah Witt <sarah.witt@datadoghq.com>
Co-authored-by: cecilia saixue watt <cecilia.watt@datadoghq.com>

Co-authored-by: Sarah Witt <sarah.witt@datadoghq.com>
Co-authored-by: cecilia saixue watt <cecilia.watt@datadoghq.com>
  • Loading branch information
3 people authored and steveny91 committed Oct 27, 2022
1 parent 17c1214 commit bf574cb
Show file tree
Hide file tree
Showing 63 changed files with 12,929 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .azure-pipelines/templates/test-all-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,9 @@ jobs:
- checkName: iis
displayName: IIS
os: windows
- checkName: impala
displayName: Impala
os: linux
- checkName: istio
displayName: Istio
os: linux
Expand Down
9 changes: 9 additions & 0 deletions .codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,10 @@ coverage:
target: 75
flags:
- iis
Impala:
target: 75
flags:
- impala
Istio:
target: 75
flags:
Expand Down Expand Up @@ -947,6 +951,11 @@ flags:
paths:
- iis/datadog_checks/iis
- iis/tests
impala:
carryforward: true
paths:
- impala/datadog_checks/impala
- impala/tests
istio:
carryforward: true
paths:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/config/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,8 @@ integration/ignite:
- ignite/**/*
integration/iis:
- iis/**/*
integration/impala:
- impala/**/*
integration/istio:
- istio/**/*
integration/jboss_wildfly:
Expand Down
2 changes: 2 additions & 0 deletions impala/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# CHANGELOG - Impala

99 changes: 99 additions & 0 deletions impala/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# Agent Check: Impala

## Overview

This check monitors [Impala][1] through the Datadog Agent.

## Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the [Autodiscovery Integration Templates][3] for guidance on applying these instructions.

### Installation

The Impala check is included in the [Datadog Agent][2] package.
No additional installation is needed on your server.

### Configuration

1. Edit the `impala.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your Impala performance data. See the [sample impala.d/conf.yaml][4] for all available configuration options.

Here is an example monitoring a daemon:

```yaml
init_config:

instances:
## @param service_type - string - required
## The Impala service you want to monitor. Possible values are `daemon`, `statestore`, and `catalog`.
#
- service_type: daemon

## @param openmetrics_endpoint - string - required
## The URL exposing metrics in the OpenMetrics format.
##
## The default port for the services are:
## - Daemon: 25000
## - Statestore: 25010
## - Catalog: 25020
#
openmetrics_endpoint: http://%%host%%:25000/metrics_prometheus
```
You can also monitor several services at the same time with the same agent:
```yaml
init_config:

instances:

- service_type: daemon
service: daemon-1
openmetrics_endpoint: http://<DAEMON-1-IP>:25000/metrics_prometheus
- service_type: daemon
service: daemon-2
openmetrics_endpoint: http://<DAEMON-2-IP>:25000/metrics_prometheus
- service_type: statestore
openmetrics_endpoint: http://<STATESTORE-IP>:25010/metrics_prometheus
- service_type: catalog
openmetrics_endpoint: http://<CATALOG-IP>:25020/metrics_prometheus
```
2. [Restart the Agent][5].
### Validation
[Run the Agent's status subcommand][6] and look for `impala` under the Checks section.

## Data Collected

### Metrics

See [metadata.csv][7] for a list of metrics provided by this integration.

### Events

The Impala integration does not include any events.

### Service Checks

See [service_checks.json][8] for a list of service checks provided by this integration.

### Logs

The Impala integration can collect logs from the Impala services and forward them to Datadog. See [the example configuration file][10] on how to collect all logs.

## Troubleshooting

Need help? Contact [Datadog support][9].


[1]: https://impala.apache.org
[2]: https://app.datadoghq.com/account/settings#agent
[3]: https://docs.datadoghq.com/agent/kubernetes/integrations/
[4]: https://github.com/DataDog/integrations-core/blob/master/impala/datadog_checks/impala/data/conf.yaml.example
[5]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
[6]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
[7]: https://github.com/DataDog/integrations-core/blob/master/impala/metadata.csv
[8]: https://github.com/DataDog/integrations-core/blob/master/impala/assets/service_checks.json
[9]: https://docs.datadoghq.com/help/
[10]: https://github.com/DataDog/integrations-core/blob/master/impala/datadog_checks/impala/data/conf.yaml.example#L632-L755
141 changes: 141 additions & 0 deletions impala/assets/configuration/spec.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
name: Impala
files:
- name: impala.yaml
options:
- template: init_config
options:
- template: init_config/openmetrics
- template: instances
options:
- name: service_type
required: true
description: |
The Impala service you want to monitor. Possible values are `daemon`, `statestore`, and `catalog`.
value:
type: string
display_default: daemon
example: daemon
enum:
- 'daemon'
- 'statestore'
- 'catalog'
- template: instances/openmetrics
overrides:
openmetrics_endpoint.value.example: http://%%host%%:25000/metrics_prometheus
openmetrics_endpoint.description: |
The URL exposing metrics in the OpenMetrics format.
The default port for the services are:
- Daemon: 25000
- Statestore: 25010
- Catalog: 25020
- template: logs
example:
- type: file
path: /opt/impala/logs/impalad.INFO
source: impala
tags:
- service_type:daemon
log_processing_rules:
- type: multi_line
pattern: ^[IWEF]\d{4} (\d{2}:){2}\d{2}
name: new_log_start_with_log_level_and_date
- type: file
path: /opt/impala/logs/impalad.WARNING
source: impala
tags:
- service_type:daemon
log_processing_rules:
- type: multi_line
pattern: ^[IWEF]\d{4} (\d{2}:){2}\d{2}
name: new_log_start_with_log_level_and_date
- type: file
path: /opt/impala/logs/impalad.ERROR
source: impala
tags:
- service_type:daemon
log_processing_rules:
- type: multi_line
pattern: ^[IWEF]\d{4} (\d{2}:){2}\d{2}
name: new_log_start_with_log_level_and_date
- type: file
path: /opt/impala/logs/impalad.FATAL
source: impala
tags:
- service_type:daemon
log_processing_rules:
- type: multi_line
pattern: ^[IWEF]\d{4} (\d{2}:){2}\d{2}
name: new_log_start_with_log_level_and_date
- type: file
path: /opt/impala/logs/catalogd.INFO
source: impala
tags:
- service_type:catalog
log_processing_rules:
- type: multi_line
pattern: ^[IWEF]\d{4} (\d{2}:){2}\d{2}
name: new_log_start_with_log_level_and_date
- type: file
path: /opt/impala/logs/catalogd.WARNING
source: impala
tags:
- service_type:catalog
log_processing_rules:
- type: multi_line
pattern: ^[IWEF]\d{4} (\d{2}:){2}\d{2}
name: new_log_start_with_log_level_and_date
- type: file
path: /opt/impala/logs/catalogd.ERROR
source: impala
tags:
- service_type:catalog
log_processing_rules:
- type: multi_line
pattern: ^[IWEF]\d{4} (\d{2}:){2}\d{2}
name: new_log_start_with_log_level_and_date
- type: file
path: /opt/impala/logs/catalogd.FATAL
source: impala
tags:
- service_type:catalog
log_processing_rules:
- type: multi_line
pattern: ^[IWEF]\d{4} (\d{2}:){2}\d{2}
name: new_log_start_with_log_level_and_date
- type: file
path: /opt/impala/logs/statestored.INFO
source: impala
tags:
- service_type:statestore
log_processing_rules:
- type: multi_line
pattern: ^[IWEF]\d{4} (\d{2}:){2}\d{2}
name: new_log_start_with_log_level_and_date
- type: file
path: /opt/impala/logs/statestored.WARNING
source: impala
tags:
- service_type:statestore
log_processing_rules:
- type: multi_line
pattern: ^[IWEF]\d{4} (\d{2}:){2}\d{2}
name: new_log_start_with_log_level_and_date
- type: file
path: /opt/impala/logs/statestored.ERROR
source: impala
tags:
- service_type:statestore
log_processing_rules:
- type: multi_line
pattern: ^[IWEF]\d{4} (\d{2}:){2}\d{2}
name: new_log_start_with_log_level_and_date
- type: file
path: /opt/impala/logs/statestored.FATAL
source: impala
tags:
- service_type:statestore
log_processing_rules:
- type: multi_line
pattern: ^[IWEF]\d{4} (\d{2}:){2}\d{2}
name: new_log_start_with_log_level_and_date
Loading

0 comments on commit bf574cb

Please sign in to comment.