Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fahl-design/log4php-slack-appender
A log4php appender build as wrapper for "maknz/slack" package
https://github.com/fahl-design/log4php-slack-appender
log4php log4php-appender logging slack
Last synced: 4 days ago
JSON representation
A log4php appender build as wrapper for "maknz/slack" package
- Host: GitHub
- URL: https://github.com/fahl-design/log4php-slack-appender
- Owner: Fahl-Design
- License: mit
- Created: 2016-11-27T15:42:02.000Z (almost 8 years ago)
- Default Branch: develop
- Last Pushed: 2021-12-13T11:31:12.000Z (almost 3 years ago)
- Last Synced: 2024-11-11T03:44:13.953Z (5 days ago)
- Topics: log4php, log4php-appender, logging, slack
- Language: PHP
- Homepage: https://fahl-design.github.io/log4php-slack-appender/
- Size: 240 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Slack as appender for log4php
## Status
[](https://www.versioneye.com/user/projects/583b5debe7cea0003d1985fb)
[](https://packagist.org/packages/fahl-design/log4php-slack-appender)
[](https://packagist.org/packages/fahl-design/log4php-slack-appender)
[](https://packagist.org/packages/fahl-design/log4php-slack-appender)
[](https://packagist.org/packages/fahl-design/log4php-slack-appender)
[](https://packagist.org/packages/fahl-design/log4php-slack-appender)
[](https://packagist.org/packages/fahl-design/log4php-slack-appender)
[](https://codeclimate.com/github/Fahl-Design/log4php-slack-appender/maintainability)
[](https://codeclimate.com/github/Fahl-Design/log4php-slack-appender/test_coverage)
[](https://www.codacy.com/app/Fahl-Design/log4php-slack-appender?utm_source=github.com&utm_medium=referral&utm_content=Fahl-Design/log4php-slack-appender&utm_campaign=Badge_Grade)
[](https://www.codacy.com/app/Fahl-Design/log4php-slack-appender?utm_source=github.com&utm_medium=referral&utm_content=Fahl-Design/log4php-slack-appender&utm_campaign=Badge_Coverage)
[](https://packagist.org/packages/fahl-design/log4php-slack-appender)
[](https://packagist.org/packages/fahl-design/log4php-slack-appender)
### Master Branch
[](https://travis-ci.org/Fahl-Design/log4php-slack-appender)
[](https://styleci.io/repos/74897031)
[](https://codecov.io/gh/Fahl-Design/log4php-slack-appender)
### Develop Branch
[](https://travis-ci.org/Fahl-Design/log4php-slack-appender)
[](https://styleci.io/repos/74897031)
[](https://codecov.io/gh/Fahl-Design/log4php-slack-appender)
## Description
This package allows you to use [Slack for PHP](https://github.com/maknz/slack) easily and elegantly in your app as an [log4php](https://logging.apache.org) appender.
Read the instructions below to get it set up.
## Requirements
PHP >= 7.1
## Installation
You can install the package using the [Composer](https://getcomposer.org/) package manager. You can install it by running this command in your project root:
```sh
composer require fahl-design/log4php-slack-appender
```
Then [create an incoming webhook](https://my.slack.com/services/new/incoming-webhook) for each Slack team you'd like to send messages to. You'll need the webhook URL(s) in order to configure this package.
After you got your hook url add it as endpoint to your configuration
### XML appender config example
```xml
```
### php (config.php) appender config example
```php
[
'level' => 'DEBUG',
'appenders' => ['slack_appender'],
],
'myLogger' => [
'appenders' => ['slack_appender'],
],
'appenders' => [
'slack_appender' => [
'class' => Slack::class,
'params' => [
Config::KEY_ENDPOINT => 'https://hooks.slack.com/services/XXXXXXXXXXXXXXX/XXXXXXXXXXXXXXX/XXXXXXXXXXXXXXX',
Config::KEY_CHANNEL => '#general',
Config::KEY_USERNAME => 'log4php',
Config::KEY_ICON => ':ghost:', // emoji or an icon url
Config::KEY_ALLOW_MARKDOWN => true,
Config::KEY_MARKDOWN_IN_ATTACHMENTS_FIELDS => [
Config::VALUE_MARKDOWN_IN_ATTACHMENTS_PRETEXT,
Config::VALUE_MARKDOWN_IN_ATTACHMENTS_TEXT,
Config::VALUE_MARKDOWN_IN_ATTACHMENTS_TITLE,
Config::VALUE_MARKDOWN_IN_ATTACHMENTS_FIELDS,
Config::VALUE_MARKDOWN_IN_ATTACHMENTS_FALLBACK
],
Config::KEY_AS_ATTACHMENT => true,
Config::KEY_LINK_NAMES => true,
Config::KEY_UNFURL_LINKS => false,
Config::KEY_UNFURL_MEDIA => true,
Config::KEY_SET_ICON_BY_LOG_LEVEL => true,
Config::KEY_ADD_LOGGER_TO_MESSAGE => true
]
]
]
];
```
## Usage
Check example (src/examples)
```php
fatal('root-logger-fatal-message');
$logger = Logger::getLogger('myLogger');
$logger->warn('warn-message @channel *WATTT*');
$logger = Logger::getLogger('myLogger');
$logger->debug('debug-message');
$logger->info('info-message');
$logger->warn('warn-message @channel *WATTT*');
$logger->error('error-message');
$logger->fatal('fatal-message');
} catch (\Throwable $e) {
\print_r($e->getMessage());
\print_r($e->getTraceAsString());
exit(255);
}
```