README

Repository

ami-praha/ai-logger
Description: A Laravel package providing a logging channel that sends log messages to an external webhook.

Overview

This package adds a custom Laravel logging channel called ai-logger. When used, it sends log messages (and context data) as JSON payloads to a configured webhook URL.

Installation

Require the package via Composer:

composer require ami-praha/ai-logger:"0.0.*"

No further configuration file publishing is necessary.

Configuration

Environment Variable

Set the webhook URL in your application's .env file:

AI_LOGGER_WEBHOOK_URL="http://ai-logger.test/api/receive"
AI_LOGGER_SOURCE_CODE="EXAMPLEAPP"
AI_LOGGER_SOURCE_NAME="Example App"
AI_LOGGER_SOURCE_URL="http://example-app.test"
AI_LOGGER_SOURCE_GIT_PROJECT_OWNER="EXP"
AI_LOGGER_SOURCE_GIT_PROJECT_NAME="example_app"
AI_LOGGER_SOURCE_JIRA_PROJECT_CODE="EXPAPP"
AI_LOGGER_SOURCE_JIRA_PARENT_PROJECT_KEY="EXPAPP-123"

Configuring Logging Channel

In Laravel's config/logging.php, add a new channel ai-logger. Also if you are using a stack channel and want to automatically send any logs to ai-logger (recommended), add it to stack.channels array:

// config/logging.php
return [
    'default' => env('LOG_CHANNEL', 'stack'),

    'channels' => [
        // other channels...

        'stack' => [
            'driver' => 'stack',
            'channels' => ['single', 'slack', 'ai-logger'],
        ],

        'ai-logger' => [
            'driver' => 'ai-logger',
            'webhookUrl' => env('AI_LOGGER_WEBHOOK_URL'),
            'sourceCode' => env('AI_LOGGER_SOURCE_CODE'),
            'sourceName' => env('AI_LOGGER_SOURCE_NAME'),
            'sourceUrl' => env('AI_LOGGER_SOURCE_URL'),
            'sourceGitProjectOwner' => env('AI_LOGGER_SOURCE_GIT_PROJECT_OWNER'),
            'sourceGitProjectName' => env('AI_LOGGER_SOURCE_GIT_PROJECT_NAME'),
            'sourceJiraProjectCode' => env('AI_LOGGER_SOURCE_JIRA_PROJECT_CODE'),
            'sourceJiraParentProjectKey' => env('AI_LOGGER_SOURCE_JIRA_PARENT_PROJECT_KEY'),
            'level' => 'warning',
        ],
    ],
];

Usage

To log using AI Logger, specify the ai-logger channel in your code:

use Illuminate\Support\Facades\Log;

Log::channel('ai-logger')->info('Hello from AI Logger', ['extra_data' => 'test']);

// Other log levels work similarly
Log::channel('ai-logger')->error('Something went wrong.', [
    'exception' => 'Some exception info',
]);

This will send the log message, context data, log level, and timestamp as a JSON payload to the configured webhook URL.

Verifying Functionality

1. Set up a Test Webhook: Use tools like Webhook.site or RequestBin to create a temporary webhook endpoint.

2. Trigger a Log: Execute a log statement:

   Log::channel('ai-logger')->info('Testing AI Logger');

3. Inspect Received Payload: Confirm the JSON payload arrives at your test webhook.

Requirements

• PHP: ^7.4 | ^8.0 | ^8.1 | ^8.2 | ^8.3
• Laravel: ^8.0 | ^9.0 | ^10.0 | ^11.0 | ^12.0

Contributing

Contributions are welcome!

1. Fork and create a feature branch.
2. Submit your changes through a Pull Request.
3. Provide a clear description of your updates.

For bugs or feature requests, please create an issue on GitHub.

License

Licensed under the MIT License.

Thank you for using AI Logger! If you have questions, open an issue on GitHub or contact the maintainer.