Download the PHP package officegest/api-logger without Composer

On this page you can find all versions of the php package officegest/api-logger. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package api-logger

Officegest Api Logger

This is a laravel package to save logs from api.

Installation

composer require officegest/api-logger

Publish the config file for this package. This will add the file config/officegest-api-logger-config.php, where you can configure this package.

$ php artisan vendor:publish --tag=officegest-api-logger-config

You need add this variables to your .env

API_LOGGER_ELASTIC_HOST="your_elastic_url:port"
API_LOGGER_ELASTIC_LOGS_INDEX="your_index_name"

## Optional
#API_LOGGER_ELASTIC_USERNAME="your_user"
#API_LOGGER_ELASTIC_PASSWORD="your_password"

Usage

Add middleware alias to $middlewareAliases

//app/Http/Kernel.php (l10)
'logger' => \OfficegestApiLogger\Middlewares\OfficegestApiLoggerMiddleware::class,

Add middleware at routes you want log to elasticsearch

/*
|--------------------------------------------------------------------------
| Example add middleware to group of endpoints
|--------------------------------------------------------------------------
*/
Route::middleware('logger')->controller(YourController::class)
    ->name('yourname.')
    ->prefix('yourprefix')
    ->group(function () {
        ...
    });

Attaching custom fields to every log (e.g. tenant_id)

Each host application can register a context resolver in a service provider. The callback runs on every log call and its return array is merged into the payload under a new top-level context key. Non-array returns and thrown exceptions are silently discarded so the logger stays best-effort.

//app/Providers/AppServiceProvider.php
use OfficegestApiLogger\OfficegestApiLogger;

public function boot(): void
{
    OfficegestApiLogger::resolveContextUsing(fn () => [
        'tenant_id' => tenant()?->id,
        'correlation_id' => request()->header('X-Correlation-Id'),
    ]);
}

The resulting document indexed in Elasticsearch will contain:

{ "version": "1.0", "user": "...", "context": { "tenant_id": 42, "correlation_id": "..." }, "data": { ... } }

Pass null to clear the resolver (useful in tests and between Octane requests if your application rebinds it per worker).

Security

If you discover any security related issues, please email [email protected] or use issues of this repo.

Credits

All versions of api-logger with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
ext-json Version *
elasticsearch/elasticsearch Version ^8.17.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package officegest/api-logger contains the following files

Loading the files please wait ...