| Directory | Description |
|---|---|
| conf | dashboards and data sources for provisioning in grafana |
| deploy | YAML configuration files for the monitor stack |
| images | contains png included in this README |
| stable | Helm Charts for Kubernetes Environments |
QuickStart in Docker using Docker Compose
Setup Manually in Docker using Docker Run
NuoDB Insights is a visual monitor tool that aids NuoDB practitioners in monitoring NuoDB database health, resource consumption, and application workload processed in real-time and historically using an intuitive graphical interface. It can be installed at database startup or after. It also installs locally on the same nodes/hosts your database runs and supports all NuoDB database deployment environments: Kubernetes, Docker, and physical host / Virtual Machine environments.
| Dependency | Description & version |
|---|---|
| NuoDB | A distributed SQL database. 4.0 or newer |
| NuoDB Collector | The stats collector daemon. 1.1.0 or newer |
| InfluxDB | Time-series database. Only version 2.X is supported. NuoDB recommends version 2.7 or later. |
| Grafana | Dashboards visualization. NuoDB recommends version 7.5.4 or later. |
For a complete example on how to set up the NuoDB database with NuoDB Insights monitoring, you can use docker compose.
This repository contains a Docker Compose file (deploy/docker-compose.yml) which will start:
- 1 Admin Processes
- 1 Storage Manager
- 2 Transaction Engines
- 3 NuoDB Collector containers (1 for SM, 2 for TE)
- 1 InfluxDB database
- 1 Grafana and NuoDB Dashboards
- 1 YCSB Demo Workload generator
Clone the NuoDB Insights repository and cd into it:
git clone https://github.com/nuodb/nuodb-insights.git
cd nuodb-insights
Then run docker-compose up to start the processes specified in the Docker Compose file:
docker-compose -f deploy/docker-compose.yaml up -d
Stop processes started with docker-compose up by running the following command:
docker-compose -f deploy/docker-compose.yaml down
If you already have a NuoDB database running, and you only need to start NuoDB insights, run the deploy/monitor-stack.yaml file instead.
Once all components have been installed, NuoDB performance can be visualized by navigating to the NuoDB Insights WebUI dashboard available at http://:3000, where <hostgrafana> is the host that the Grafana server was started on.
From this login screen, enter the default username and password combination for Grafana which is admin/admin.
You will then be prompted to create a new password.
Once logged into the interface, browse the available Dashboards and select the "NuoDB Ops System Overview" to get started!
docker pull nuodb/nuodb:latest
docker pull nuodb/nuodb-collector:latest
docker pull influxdb:2.7
docker pull grafana/grafana:9.5.6
git clone https://github.com/nuodb/nuodb-insights.git
cd nuodb-insights
-
Create a Docker network.
All NuoDB components should be running on this network.
docker network create nuodb-net
-
Start an InfluxDB server.
Use the provided init script to generate the required databases.
docker run -d --name influxdb \
--network nuodb-net \
-p 8086:8086 \
-p 8082:8082 \
--env DOCKER_INFLUXDB_INIT_MODE=setup \
--env DOCKER_INFLUXDB_INIT_USERNAME=<your_username> \
--env DOCKER_INFLUXDB_INIT_PASSWORD=<your_password> \
--env DOCKER_INFLUXDB_INIT_ORG=<name_of_organization> \
--env DOCKER_INFLUXDB_INIT_RETENTION=<bucket_retention_time> \
--env DOCKER_INFLUXDB_INIT_BUCKET=<influxdb_bucket_name> \
--env DOCKER_INFLUXDB_INIT_ADMIN_TOKEN=<your_influxdb_token> \
-v $PWD/deploy/initdb.sh:/docker-entrypoint-initdb.d/initdb.sh \
influxdb:2.7
- Start Grafana with the NuoDB dashboards.
docker run -d --name grafana \
--network nuodb-net \
-p 3000:3000 \
--env INFLUX_HOST=influxdb \
--env INFLUXDB_TOKEN=<influxdb_token> \
-v $PWD/conf/provisioning:/etc/grafana/provisioning \
grafana/grafana:9.5.6
-
If you haven't already, start your NuoDB database.
-
Start the NuoDB Collector daemons for each NuoDB database process.
-
Start the NuoDB YCSB workload generator to explore the various dashboards with live monitoring data.
docker run -dit --name ycsb1 \
--hostname ycsb1 \
--network nuodb-net \
--env PEER_ADDRESS=nuoadmin1 \
--env DB_NAME=test \
--env DB_USER=dba \
--env DB_PASSWORD=goalie \
nuodb/ycsb:latest /driver/startup.sh
This Github repository contains the NuoDB Insights Helm Chart and all the required components to install and deploy NuoDB Insights.
- Getting Started with Helm describes how to install and configure Helm on a client host.
- Deploying NuoDB using Helm Charts contains a quick primer on how to deploy a NuoDB database using the NuoDB Helm Charts.
- Deploying NuoDB Insights using Helm Charts describes how to install and configure NuoDB Insights.
The following installation instructions apply to Red Hat and CentOS Linux distributions on bare-metal or VMs. For other platforms, see InfluxDB and Grafana installation instructions.
Install InfluxDB on the same host machine referred to by <hostinflux> in the NuoDB Collector installation instructions.
wget https://dl.influxdata.com/influxdb/releases/influxdb2-2.7.0.x86_64.rpm
sudo yum localinstall influxdb2-2.7.0.x86_64.rpm
sudo service influxdb start
If not using systemd, InfluxDB can be started directly as follows:
env $(cat /etc/default/influxdb | xargs) influxd -config /etc/influxdb/influxdb.conf
On a host in your NuoDB domain, install Grafana and configure it to use the NuoDB-Insights dashboards.
wget https://dl.grafana.com/oss/release/grafana-9.5.6-1.x86_64.rpm
sudo yum install -y grafana-9.5.6-1.x86_64.rpm
git clone https://github.com/nuodb/nuodb-insights.git
sudo rm -rf /etc/grafana/provisioning
sudo cp -r nuodb-insights/conf/provisioning /etc/grafana
sudo mkdir -p /etc/grafana/provisioning/notifiers /etc/grafana/provisioning/plugins
sudo chown -R root:grafana /etc/grafana/provisioning
sudo chmod 755 $(find /etc/grafana/provisioning -type d)
sudo chmod 640 $(find /etc/grafana/provisioning -type f)
Once installed, Grafana can be started with InfluxDB as a datasource by using the INFLUX_HOST environment variable. In the below echo command, peplace <hostinflux> with the machine host name that is running your InfluxDB instance, and run,
echo "INFLUX_HOST=<hostinflux>" >> /etc/sysconfig/grafana-server
sudo systemctl enable grafana-server
sudo systemctl start grafana-server
If not using systemd, Grafana can be started as follows:
sudo /etc/rc.d/init.d/grafana-server start
Follow the instructions for installing the NuoDB Collector on bare-metal. The NuoDB Collector must be set up on all hosts that will run NuoDB database processes.
Once all components have been set up, NuoDB performance can be visualized by navigating to the NuoDB Insights - NuoDB Ops System Overview dashboard at http://<hostgrafana>:3000/d/000000004/nuodb-ops-system-overview, where <hostgrafana> is the host that the Grafana server was started on. The default password in Grafana is admin:admin.
Insights 2.x introduces a breaking change. In this update, a crucial shift is the migration from InfluxDB version 1.8 to 2.7. For those transitioning from the prior Insights 1.x iteration to 2.x, it's important to be aware that access to historical InfluxDB data from the previous version will not be retained due to the migration.
Run the following command for migrating from Insights 1.2 to 2.0.
helm upgrade <release_name>
This project is still under active development, so you might run into issues. If you do, please don't be shy about letting us know, or better yet, contribute a fix or feature.