Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/idealista/prometheus_oracle_exporter_role

Ansible role to install an Oracle Exporter
https://github.com/idealista/prometheus_oracle_exporter_role

ansible-role debian monitoring oracle oracle-database prometheus prometheus-exporter

Last synced: 28 days ago
JSON representation

Ansible role to install an Oracle Exporter

Awesome Lists containing this project

README

        

![Logo](https://raw.githubusercontent.com/idealista/prometheus_oracle_exporter_role/master/logo.gif)

[![Build Status](https://travis-ci.com/idealista/prometheus_oracle_exporter_role.png)](https://travis-ci.com/idealista/prometheus_oracle_exporter_role)
[![Ansible Galaxy](https://img.shields.io/badge/galaxy-idealista.prometheus_oracle_exporter_role-B62682.svg)](https://galaxy.ansible.com/idealista/prometheus_oracle_exporter_role)

# Prometheus Oracle Exporter Ansible role

This ansible role installs a Prometheus Oracle Exporter in a Debian environment.

- [Getting Started](#getting-started)
- [Prerequisities](#prerequisities)
- [Installing](#installing)
- [Usage](#usage)
- [Testing](#testing)
- [Built With](#built-with)
- [Versioning](#versioning)
- [Authors](#authors)
- [License](#license)
- [Contributing](#contributing)

## Getting Started
These instructions will get you a copy of the role for your Ansible playbook. Once launched, it will install an [Prometheus Oracle Exporter](https://github.com/iamseth/oracledb_exporter) server in a Debian system.

### Prerequisities

Ansible 2.8.x.x version installed.
Inventory destination should be a Debian environment with Oracle Instant Client installed. You can install it with this [ansible role](https://github.com/idealista/oracle_instant_client_role).

For testing purposes, [Molecule](https://molecule.readthedocs.io/) with [Docker](https://www.docker.com/) as driver.

### Installing

Create or add to your roles dependency file (e.g requirements.yml):

```
- src: idealista.prometheus_oracle_exporter_role
version: 1.3.0
name: prometheus_oracle_exporter
```

Install the role with ansible-galaxy command:

```
ansible-galaxy install -p roles -r requirements.yml -f
```

Use in a playbook:

```
---
- hosts: someserver
roles:
- role: prometheus_oracle_exporter
```

## Usage

Look to the [defaults](defaults/main.yml) properties file to see the possible configuration properties.

To use custom metrics override the ```oracle_exporter_custom_metrics_path``` variable with the path to the your custom metrics file.

You will likely want to change the data source, you can do it overriding the ```oracle_exporter_data_source``` variable (e.g. system/oracle@oracle_database:1521/xe)

Certain metrics need the service to have set up the ```NLS_LANG``` environment variable. You can set its value by defining the ```oracle_exporter_nls_lang``` variable.

To change the the maximum number of open connections override ```oracle_exporter_max_open_conns```. The default value is 10.

To change the the maximum number of idle connections override ```oracle_exporter_max_idle_conns```. The default value is 0.

## Testing

### Install dependencies

```sh
$ pipenv sync
```

For more information read the [pipenv docs](https://docs.pipenv.org/).

### Testing

```sh
$ pipenv run molecule test
```

## Built With

![Ansible](https://img.shields.io/badge/ansible-2.8.0.0-green.svg)
![Molecule](https://img.shields.io/badge/molecule-2.22.0-green.svg)
![Goss](https://img.shields.io/badge/goss-0.3.7-green.svg)

## Versioning

For the versions available, see the [tags on this repository](https://github.com/idealista/prometheus_oracle_exporter_role/tags).

Additionaly you can see what change in each version in the [CHANGELOG.md](CHANGELOG.md) file.

## Authors

* **Idealista** - *Work with* - [idealista](https://github.com/idealista)

See also the list of [contributors](https://github.com/idealista/prometheus_oracle_exporter_role/contributors) who participated in this project.

## License

![Apache 2.0 License](https://img.shields.io/hexpm/l/plug.svg)

This project is licensed under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license - see the [LICENSE](LICENSE) file for details.

## Contributing

Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.