Skip to content

README.en.md

Latest commit

 

History

History
70 lines (48 loc) · 3.21 KB

README.en.md

File metadata and controls

70 lines (48 loc) · 3.21 KB

deutsche Version english version

OxLogIQ

Overview

This is the provider for the HTTP API based logging service for integration into the OxLogIQ logger for the OXID eShop.

Please also refer to the OxLogIQ documentation.

Features

  • Transfer log entries to HTTP API (e.g. ElasticSearch) (optional + adjustable)
  • Simple configuration via config.inc.php or environment variables

Installation

  1. Install via Composer 
    composer require d3/oxlogiq_httpapi
  2. Set configuration
  3. Clear the shop's TMP folder

Configuration

The following parameters can be adjusted using these variables:

Setting Description
oxlogiq_httpApiEndpoint optional: Http API endpoint (e.g. for ElasticSearch / ELK Stack)
oxlogiq_httpApiKey optional: Http API key (e.g. for ElasticSearch / ELK Stack)

Define these settings either as an environment variable or as a variable in the shop's config.inc.php file.

Code example

$this->oxlogiq_httpApiEndpoint = 'https://my-observability-project.es.eu-central-1.aws.elastic.cloud/logs/_doc';
$this->oxlogiq_httpApiKey = 'ApiKey myApiKey';

Changelog

See CHANGELOG for further information.

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!

  • Fork the Project
  • Create your Feature Branch (git checkout -b feature/AmazingFeature)
  • Commit your Changes (git commit -m 'Add some AmazingFeature')
  • Push to the Branch (git push origin feature/AmazingFeature)
  • Open a Pull Request

Licence of this software (OxLogIQ_HttpApi) [MIT]

(2025-12-14)

Copyright (c) D3 Data Development (Inh. Thomas Dartsch)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.