# @kaname-png/plugin-influxdb
**Plugin for
[`@sapphire/framework`](https://github.com/sapphiredev/framework) to publish stats to an
[`InfluxDB`](https://www.influxdata.com) instance.**
[](https://github.com/kaname-png/neko-plugins/blob/main/LICENSE.md)
[](https://codecov.io/gh/kaname-png/neko-plugins)
[](https://www.npmjs.com/package/@kaname-png/plugin-influxdb)
[](https://www.npmjs.com/package/@kaname-png/plugin-influxdb)
## Description
This plugin lets you send your bot's statistics to InfluxDB
More information about InfluxDB can be found on its [website](https://www.influxdata.com).
## Features
- Fully ready for TypeScript!
- Includes ESM ready entrypoint
- Easy to use
## Installation
`@kaname-png/plugin-influxDB` depends on the following packages. Be sure to install these along with this package!
- [`@sapphire/framework`](https://www.npmjs.com/package/@sapphire/framework)
- [`@influxdata/influxdb-client`](https://www.npmjs.com/package/@influxdata/influxdb-client)
- [`discord.js`](https://www.npmjs.com/package/discord.js)
You can use the following command to install this package, or replace `npm install` with your package manager of choice.
```sh
npm install @influxdata/influxdb-client @sapphire/framework discord.js
```
PS: You can view events by default [here](#the-default-listeners).
---
## Usage
If your register the plugin:
```typescript
import "@kaname-png/plugin-influxdb/register";
const client = new SapphireClient({
/* your bot options */
analytics: {
loadDefaultListeners: true, // (Optional) Load the default events .
// option to passed influxdb deps
},
});
async function main() {
await client.login();
}
void main();
```
OR
The first step, is to import the Client from the package:
```typescript
import { Client } from "@kaname-png/plugin-influxdb";
```
You can choose between defining the options explicitly, in the following manner:
```typescript
const client = new Client({
url: "https://example.org",
token: "my-secret-token",
});
```
Or defining the options via environment variables, they are:
**Client**:
- `INFLUX_OPTIONS_STRING`: A connection string, overrides all the options below.
- `INFLUX_URL`: `ConnectionOptions.url`, the base URL to be used.
- `INFLUX_PROXY_URL`: `ConnectionOptions.proxyUrl`, the full HTTP web proxy URL including schema.
- `INFLUX_TIMEOUT`: `ConnectionOptions.timeout`, the socket timeout, defaults to 10 seconds. If defined, this will be parsed and validated to a number.
- `INFLUX_TOKEN`: `ConnectionOptions.token`, the authentication token.
**API**:
- `INFLUX_ORG`: `Client.Options.org`, the organization to use for the query and write APIs.
- `INFLUX_WRITE_BUCKET`: `Client.Options.writeBucket`, the bucket to write to in the write API.
- `INFLUX_WRITE_PRECISION`: `Client.Options.writePrecision`, the write precision to use in the write API.
> **Note**: If `Client.Options.org` is unset, none of the APIs will be created.
> **Note**: If `Client.Options.writeBucket` is unset, the Write API will not be created.
---
### \*\*The default listeners:
- [`plugin-api`](https://github.com/sapphiredev/plugins/tree/main/packages/api): "error"
- [`plugin-subcommands`](https://github.com/sapphiredev/plugins/tree/main/packages/subcommands): "MessageSubcommandError", "chatInputSubcommandError"
- [`plugin-scheduled-tasks`](https://github.com/sapphiredev/plugins/tree/main/packages/scheduled-tasks): "scheduledTaskError"
- [`framework`](https://github.com/sapphiredev/framework): "messageCommandError", "chatInputCommandError", "contextMenuCommandError", "commandAutocompleteInteractionError", "error", "listenerError" and "interactionHandlerError"
---
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
Contributions of any kind welcome!
