ProcessLogstash by blue-tomato

Send ProcessWire Logs to Logstash/Kibana

ProcessLogstash

License: MIT ProcessWire 3

This Module for ProcessWire CMS/CMF will send your ProcessWire Logs to Logstash via HTTP-Input.

Installation


  1. Execute the following command in the root directory of your ProcessWire installation:
composer require blue-tomato/process-logstash
  1. ProcessWire will detect the module and list it in the backend's Modules > Site > ProcessLogstash section. Navigate there and install it.

  2. Add you Logstash HTTP-Input Endpoint URL into field on the Module Configuration Page

Override Endpoint or deactivate Logging on Dev/Stage Servers

If you want to override the endpoint URL set by the module configuration you can add to your config.php or config-dev.php following:

  • $config->processLogstash = [ "endpoint" => "http://localhost:9600" ]

If you want to deactivate the logging you can set this also to false:

  • $config->processLogstash = [ "endpoint" => false ]

If you want to add information about your server environment you can add following to the config.php:

  • $config->processLogstash = [ "env" => "stage" ]

This will be added as "env" to your log messages.

Add custom HTTP Header to the Request

Some Logstash cloud providers like logit.io need an API Key in the HTTP Headers. You can add it with this way in the config.php

  • $config->processLogstash = [ "customHttpHeaders" => [ "ApiKey: YOUR-API_KEY" ] ]

Request to Logstash throw a proxy server

If you have your Server behind a proxy, you can add to your config.php file following properties:

  • $config->processLogstash['proxy'] = "http://your-http-proxy-server.xyz:8888";

Support


Please open an issue for support.

Contributing


Create a branch on your fork, add commits to your fork, and open a pull request from your fork to this repository.

To get better insights and onboard you on module implementation details just open a support issue. We'll get back to you asap.

Credits


This module is made by people from Blue Tomato. If you want to read more about our work, follow us on https://dev.to/btdev

License


Find all information about this module's license in the LICENCE.txt file.

Install and use modules at your own risk. Always have a site and database backup before installing new modules.

Twitter updates

  • Adding custom actions to ProcessWire image fields in the admin, part of this week’s dev branch additions: More
    27 January 2023
  • ProcessWire 3.0.210 new main/master version released— More
    6 January 2023
  • ProcessWire 3.0.209: Core updates and an interesting AI that knows ProcessWire– More
    30 December 2022

Latest news

  • ProcessWire Weekly #456
    The 456th issue of ProcessWire Weekly covers latest core updates, introduces a new third party module called TextformatterRockDown, and more. Read on!
    Weekly.pw / 4 February 2023
  • ProcessWire 3.0.210 new main/master version
    140 commits, 55 resolved issues, dozens of new features, eight contributors, and five new pull requests make yet another great new version of ProcessWire.
    Blog / 6 January 2023
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK