Skip to content

Latest commit

 

History

History
105 lines (79 loc) · 3 KB

README.md

File metadata and controls

105 lines (79 loc) · 3 KB

OpenTelemetry Receiver/Agent for Oceanbase Database

Introduction

Oceanbase Database is a relational database management system (RDBMS). We provide this OpenTelemetry Receiver implementation tested with Oceanbase 4.x or later.

<style> .center { width: auto; display: table; margin-left: auto; margin-right: auto; } </style>

Status of the Receiver

Receiver type Status JDK required Semantic Conventions
metrics alpha JDK v8+ link

Deployment Information (for end users)

Download the installation package from OJR releases:

wget https://github.com/liurui-software/ojr/releases/download/xxx/ojr-oceanbase-db-xxx.tar

Extract the package to the desired deployment location:

tar vxf ojr-oceanbase-db-xxx.tar
cd ojr-oceanbase-db-xxx

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.

Run the Receiver/Agent synchronously:

./bin/ojr-oceanbase-db

Or Run the Receiver/Agent asynchronously:

nohup ./bin/ojr-oceanbase-db &

Note: Query the Receiver/Agent

ps -ef | grep ojr | grep -v grep

Note: Stop DataCollector

ps -ef | grep ojr | grep -v grep | awk '{printf " "$2" "}' | xargs kill -9

Build and Run (for developers)

Make sure Java SDK is installed.

java -version

Get the source code from github.com.

git clone https://github.com/liurui-software/ojr.git
cd ojr-xxx

Build with Gradle

./gradlew clean build

Run the Agent with Gradle

./gradlew run

References of configuration parameters

Parameter Scope Description Default Examples
db.system global The logical name of the DB system - Oceanbase4
db.driver global The JDBC driver of the DB system - com.mysql.jdbc.Driver
db.address instance The IP address of the DB instance - 192.168.3.14
db.port instance The internet port of the DB instance - 2881
db.username instance The user name of the DB instance - root@sys
db.password instance The BASE64 encoded password of the DB instance - TXlQYXNzd29yZA==
db.connection.url instance The JDBC connection URL of the DB instance - jdbc:mysql://localhost:2881/oceanbase?autoReconnect=true&useSSL=false
db.name instance The name of the DB instance - myDB1
db.entity.type instance The type of the DB entity (cluster or tenant) - cluster
db.tenant.name instance The tenant name of the DB tenant entity - test