@orchesty/connector-loki 1.0.1 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +75 -0
- package/dist/package.json +2 -2
- package/package.json +6 -3
package/README.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# Loki Connector
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@orchesty/connector-loki)
|
|
4
|
+
[](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE)
|
|
5
|
+
|
|
6
|
+
An [Orchesty](https://orchesty.io) connector for Grafana Loki, an open-source log aggregation system that uses a small index and highly compressed chunks to simplify operations and significantly lower storage costs.
|
|
7
|
+
|
|
8
|
+
## Application Type
|
|
9
|
+
|
|
10
|
+
**Basic**
|
|
11
|
+
|
|
12
|
+
This connector supports optional HTTP Basic authentication (username + password). Authentication is not required for deployments that are accessible without credentials. An optional `X-Scope-OrgID` tenant header can be configured for multi-tenant Loki setups.
|
|
13
|
+
|
|
14
|
+
| Field | Description |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `url` | Full URL of your Loki instance (e.g. `http://loki:3100`) |
|
|
17
|
+
| `tenant` | Tenant ID for multi-tenant Loki deployments (optional) |
|
|
18
|
+
| `user` | Username for HTTP Basic authentication (optional) |
|
|
19
|
+
| `password` | Password for HTTP Basic authentication (optional) |
|
|
20
|
+
|
|
21
|
+
## Components
|
|
22
|
+
|
|
23
|
+
| Class | Type | Description |
|
|
24
|
+
|---|---|---|
|
|
25
|
+
| `LokiGetQueryListBatch` | Batch | Executes a LogQL range query and paginates through results via `GET /loki/api/v1/query_range` |
|
|
26
|
+
|
|
27
|
+
## Setup
|
|
28
|
+
|
|
29
|
+
### Credentials
|
|
30
|
+
|
|
31
|
+
1. Ensure your Loki instance is running and accessible from Orchesty.
|
|
32
|
+
2. If your Loki deployment requires authentication, provide a username and password.
|
|
33
|
+
3. For multi-tenant Grafana Cloud setups, enter your **Tenant ID** (also called `X-Scope-OrgID`).
|
|
34
|
+
4. In Orchesty, fill in the **Url** field with the base URL of your Loki instance.
|
|
35
|
+
|
|
36
|
+
### API Documentation
|
|
37
|
+
|
|
38
|
+
Grafana Loki HTTP API: [https://grafana.com/docs/loki/latest/reference/loki-http-api/](https://grafana.com/docs/loki/latest/reference/loki-http-api/)
|
|
39
|
+
|
|
40
|
+
## Installation & Usage
|
|
41
|
+
|
|
42
|
+
Install the package:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
npm install @orchesty/connector-loki @orchesty/nodejs-sdk
|
|
46
|
+
# or
|
|
47
|
+
pnpm add @orchesty/connector-loki @orchesty/nodejs-sdk
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Register the application and nodes in your Orchesty DI container:
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
import { container } from '@orchesty/nodejs-sdk';
|
|
54
|
+
import LokiApplication from '@orchesty/connector-loki/dist/LokiApplication';
|
|
55
|
+
import LokiGetQueryListBatch from '@orchesty/connector-loki/dist/Batch/LokiGetQueryListBatch';
|
|
56
|
+
|
|
57
|
+
const app = new LokiApplication();
|
|
58
|
+
container.setApplication(app);
|
|
59
|
+
container.setNode(new LokiGetQueryListBatch(), app);
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## License
|
|
63
|
+
|
|
64
|
+
This connector is released under the **Apache License 2.0**. See the [LICENSE](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE) file for the full license text.
|
|
65
|
+
|
|
66
|
+
## Contributing
|
|
67
|
+
|
|
68
|
+
Contributions are welcome! This connector is part of the open-source [Orchesty Node.js Connectors](https://github.com/Orchesty/orchesty-nodejs-connectors) monorepo.
|
|
69
|
+
|
|
70
|
+
For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the **[Contributing to Connectors](https://orchesty.io/community/contributing-to-connectors)** guide.
|
|
71
|
+
|
|
72
|
+
All contributions should include:
|
|
73
|
+
- Source code in `src/` following the existing connector structure
|
|
74
|
+
- Tests in `src/**/__tests__/` with `input.json`, `mock.json`, and `output.json` fixtures
|
|
75
|
+
- An updated `CHANGELOG.md` entry
|
package/dist/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-loki",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.0",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
7
|
"repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"keywords": [],
|
|
18
18
|
"author": "info@hanaboso.com",
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@orchesty/nodejs-sdk": "^
|
|
20
|
+
"@orchesty/nodejs-sdk": "^5.0.13"
|
|
21
21
|
},
|
|
22
22
|
"engines": {
|
|
23
23
|
"node": ">=24"
|
package/package.json
CHANGED
|
@@ -1,17 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-loki",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.1",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
|
-
"repository":
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors"
|
|
10
|
+
},
|
|
8
11
|
"files": [
|
|
9
12
|
"dist"
|
|
10
13
|
],
|
|
11
14
|
"keywords": [],
|
|
12
15
|
"author": "info@hanaboso.com",
|
|
13
16
|
"dependencies": {
|
|
14
|
-
"@orchesty/nodejs-sdk": "^
|
|
17
|
+
"@orchesty/nodejs-sdk": "^5.0.13"
|
|
15
18
|
},
|
|
16
19
|
"engines": {
|
|
17
20
|
"node": ">=24"
|