Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jop-software/typo3-loki
Grafana Loki Client integrated into TYPO3
https://github.com/jop-software/typo3-loki
grafana grafana-loki hacktoberfest monitoring typo3 typo3-cms-extension typo3-extension
Last synced: 3 months ago
JSON representation
Grafana Loki Client integrated into TYPO3
- Host: GitHub
- URL: https://github.com/jop-software/typo3-loki
- Owner: jop-software
- License: gpl-2.0
- Created: 2022-05-05T19:59:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-06T09:32:07.000Z (over 2 years ago)
- Last Synced: 2024-09-30T08:02:40.244Z (3 months ago)
- Topics: grafana, grafana-loki, hacktoberfest, monitoring, typo3, typo3-cms-extension, typo3-extension
- Language: PHP
- Homepage: https://extensions.typo3.org/extension/loki
- Size: 71.3 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TYPO3 Loki Client
Monitor logging output of your TYPO3 installation
## Professional Support
Professional support is available, please contact [[email protected]](mailto:[email protected]) for more information.
## Configuration
There are two possible ways to use this extension.
1. Use the JsonWriter to convert all logs to JSON before writing them to the log file.
This way, you can process the logs with a different loki client like [Promtail](https://grafana.com/docs/loki/latest/clients/promtail/)
```php
$GLOBALS['TYPO3_CONF_VARS']['LOG']['writerConfiguration'] = [
// Log handling configuration for ERROR logs
// Set this to DEBUG to process all logs.
\TYPO3\CMS\Core\Log\LogLevel::ERROR => [
// Convert all logs to JSON to scrape them with loki clients like Promtail
\Jops\TYPO3\Loki\Log\Writers\JsonWriter::class => [],
],
];
```
2. Use the LokiWriter to send logs directly to a configured loki instance.
You can define labels here, that will be attached to the log line sent to loki.
See: [Configure a Loki instance](#configure-a-loki-instance)
```php
$GLOBALS['TYPO3_CONF_VARS']['LOG']['writerConfiguration'] = [
// Log handling configuration for ERROR logs
// Set this to DEBUG to process all logs.
\TYPO3\CMS\Core\Log\LogLevel::ERROR => [
// Configure LokiWrite to send logs to Loki
\Jops\TYPO3\Loki\Log\Writers\LokiWriter::class => [
"labels" => [
"key" => "value",
],
],
],
];
```
### Configure a Loki instance.
If you want to use the LokiWriter, you need to have a loki instance configured. This can be done with the Extension
Configuration in the backend or in the `AdditionalConfiguration.php`.
If your Loki installation is secured with http basic auth, you can provide those credentials here as well. Keep in mind
that the credentials **are store as plain text** in the configuration file.
This could be an example configuration:
```php
$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['loki'] = [
"base-url" => "https://loki.example.com",
// Optional: Add basic-auth credentials if needed
"basic-auth" => [
"username" => "username",
"password" => "secure-password",
],
];
```
## Supported TYPO3 Versions
The extension is only officially available and released for TYPO3 11.
If you need it in an older project, you can find a version that is compatible with TYPO3 9 and 10 in the [`typo3-9-10-compatability`](https://github.com/jop-software/typo3-loki/tree/typo3-9-10-compatability) branch.
Use `dev-typo3-9-10-compatability` as the version in composer.
## Local Development
We use [DDEV](https://ddev.com) for local development.
You get a complete ddev setup in this repository, just run `ddev start`.
## License
This project is licensed under [GPL-2.0-or-later](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html), see the [LICENSE](./LICENSE) file for more information.