Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/captainigl00/grafana-influxdb-docker-compose
Automatic configuration of Grafana and InfluxDB
https://github.com/captainigl00/grafana-influxdb-docker-compose
dashboard docker docker-compose grafana grafana-influxdb influxdb template
Last synced: 27 days ago
JSON representation
Automatic configuration of Grafana and InfluxDB
- Host: GitHub
- URL: https://github.com/captainigl00/grafana-influxdb-docker-compose
- Owner: CaptainIgl00
- License: gpl-3.0
- Created: 2024-10-21T12:51:05.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-21T15:29:48.000Z (3 months ago)
- Last Synced: 2024-10-28T05:34:06.067Z (2 months ago)
- Topics: dashboard, docker, docker-compose, grafana, grafana-influxdb, influxdb, template
- Homepage:
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Real-Time Data Visualization Stack
## Description
This project sets up a complete **monitoring environment** using **Docker Compose** to orchestrate **InfluxDB** and **Grafana**. It allows for **collecting**, **storing**, and **visualizing real-time metric data**. The configuration includes automatic initialization of InfluxDB and automatic configuration of Grafana with pre-configured data sources and dashboards.
## Table of Contents
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Project Structure](#project-structure)
- [Troubleshooting](#troubleshooting)
- [Contributing](#contributing)
- [License](#license)
## Prerequisites
- Docker installed on your machine.
- Docker Compose installed (version 3.7 or higher recommended).
## Installation
1. Clone the Repository
```bash
git clone https://github.com/CaptainIgl00/grafana-influxdb-docker-compose.git
cd grafana-influxdb-docker-compose
```
2. Modify the .env file with your own information
```env
INFLUXDB_DATABASE=db
INFLUXDB_USERNAME=user
INFLUXDB_ORG=org
INFLUXDB_PASSWORD=userpassword
INFLUXDB_TOKEN='token'
GRAFANA_USERNAME=admin
GRAFANA_PASSWORD=adminpassword
```
**Note**: Make sure to replace the values with your own information. Avoid using special characters such as quotes in the passwords to prevent interpretation issues.
3. Run the Docker Compose file
```bash
docker-compose up -d
```
4. Access Grafana at http://localhost:3000 and InfluxDB at http://localhost:8086
## Usage
In order to add **custom dashboards**, you can use the Grafana interface.
1. Create or Export a Dashboard
- Create a new dashboard in Grafana.
- Export it as JSON via Share > Export > Save to file.
2. Add the Dashboard to the Project
- Place the exported JSON file into the grafana-dashboards/ folder.
3. Next time you start the project, the dashboard will be automatically added to Grafana.
## Project Structure
```
grafana-influxdb-docker-compose/
├── docker-compose.yml # Docker Compose file
├── .env # InfluxDB and Grafana credentials
├── grafana-dashboards/ # Folder for custom dashboards
│ └── Example Dashboard.json # Example dashboard
│
└── grafana-provisioning/ # Folder for Grafana provisioning
├── datasources/
│ └── datasource.yml # Configures InfluxDB as the default data source
│
└── dashboards/
└── dashboard.yml # Automatically loads dashboards from grafana-dashboards/
```
## Troubleshooting
### Connection Issues with InfluxDB
- Verify that the environment variables are correctly defined in the .env file.
- Ensure that the init-influxdb service ran successfully by checking the logs:
```bash
docker-compose up
```
### Dashboards or Data Sources Not Loaded
- Check that the provisioning files are correctly placed in grafana-provisioning/datasources/ and grafana-provisioning/dashboards/.
- Review Grafana logs for any errors:
```bash
docker-compose logs -f grafana-influxdb-docker-compose-grafana-1
```
- Make sure that the InfluxDB token doesn't contain special characters that could be badly interpreted.
### Environment Variables Not Expanded in YAML Files
- Ensure that variables are referenced using the `${VARIABLE}` syntax in the provisioning YAML files.
- The environment variables must be exported within the Grafana container. You can verify them with:
```bash
docker exec -it grafana-influxdb-docker-compose-grafana-1 env | grep GF_
```
## Contributing
Contributions are welcome! If you find bugs or have suggestions for improvement, feel free to open an issue or a pull request.
## License
This project is licensed under the GPL-3.0 License. See the [LICENSE](LICENSE) file for details.