Skip to content

Latest commit

 

History

History
136 lines (106 loc) · 3.81 KB

README.md

File metadata and controls

136 lines (106 loc) · 3.81 KB
Raw

Data Collector for Relational Database

Requirements

  • Java 8+

Ensure that Java SDK 11+ is installed.

java -version

Run Data Collector with release (for end users)

Download the latest Release package according to the operating system.

  1. Download the installation package:
wget https://github.com/instana/otel-dc/releases/download/v1.0.3/otel-dc-rdb-0.5.4.tar
  1. Extract the package to the desired deployment location:
tar vxf otel-dc-rdb-0.5.4.tar
cd otel-dc-rdb-0.5.4
  1. Make sure following configuration files are correct for your environment:
  • config/config.yaml
  • config/logging.properties

Refine configuration file (config/config.yaml) according to your own database. Right now we provide Data Collector for following databases:

  • DaMeng database
  • Oceanbase
  • Informix Note: The default configuration file config/config.yaml is for Dameng DB. If you want to monitor an Informix DB, you can copy config/config-informix.yaml to config/config.yaml, or you can also use environment variable "DC_CONFIG" to specify the configuration file, for example:
export DC_CONFIG=config/config-informix.yaml

Notes for some parameters：

  • otel.backend.url：The OTel gRPC address of the OTel backends, for example Instana Agent (as OTel Backend): http://localhost:4317
  • otel.service.name：The Data Collector name, which can be any string you choose.
  1. Run Data Collector Run the Data Collector with the following command according to your current system:
nohup ./bin/otel-dc-rdb

Build & Run (for developers)

  1. Make sure Java SDK is installed.
java -version
  1. Get the source code from github.com.
git clone https://github.com/instana/otel-dc.git
cd otel-dc/rdb
  1. Build with Gradle
./gradlew clean build

Note: gradle 7.4 will be installed if you do not have it.

  1. Make sure following configuration files are correct for your environment:
  • config/config.yaml
  • config/logging.properties

Refine configuration file (config/config.yaml) according to your own database. Right now we provide Data Collector for following databases:

  • DaMeng database
  • Oceanbase
  • Informix Note: The default configuration file config/config.yaml is for Dameng DB. If you want to monitor an Informix DB, you can copy config/config-informix.yaml to config/config.yaml, or you can also use environment variable "DC_CONFIG" to specify the configuration file, for example:
export DC_CONFIG=config/config-informix.yaml
  1. Start up your OTLP backend which accept OTLP connections. Right now we support following protocols:
  • otlp/grpc
  • otlp/http
./gradlew run
  1. Appendix: Run binary in "build/distributions" Find the deployment package (e.g.:otel-dc-rdb-.tar/otel-dc-host-.tar/otel-dc-host-*.tar) generated by gradle in the "build/distributions/" directory, extract deployment files:
cd build/distributions/
tar vxf otel-dc-rdb-*.tar
rm -f *.tar *.zip
cd otel-dc-rdb-*

Modify the configuration files. Then, make sure following configuration files are correct for your environment.:

  • config/config.yaml
  • config/logging.properties

Run the Data Collector with following command according to your current implentation:

export DC_CONFIG=config/config.yaml
export JAVA_OPTS=-Dconfig/logging.properties
bin/otel-dc-rdb

Or run Data Collector in background

export DC_CONFIG=config/config.yaml
export JAVA_OPTS=-Dconfig/logging.properties
nohup bin/otel-dc-rdb > /dev/null 2>&1 &

Notes for useful commands:

  1. Query DataCollector
ps -ef | grep otel-dc | grep -v grep
  1. Stop DataCollector
ps -ef | grep otel-dc | grep -v grep | awk '{printf " "$2" "}' | xargs kill -9
  1. Check logging file
ls -l ~/*-dc*.log*