Download the PHP package imo-tikuwa/cakephp-operation-logs without Composer
On this page you can find all versions of the php package imo-tikuwa/cakephp-operation-logs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download imo-tikuwa/cakephp-operation-logs
More information about imo-tikuwa/cakephp-operation-logs
Files in imo-tikuwa/cakephp-operation-logs
Package cakephp-operation-logs
Short Description OperationLogs plugin for CakePHP
License MIT
FAQ
Example:
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 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.
Informations about the package cakephp-operation-logs
OperationLogs plugin for CakePHP 3 and 4
Installation
You can install this plugin into your CakePHP application using composer.
The recommended way to install composer packages is:
How to Use
Load plugin to bootstrap.php
or Application.php
Execute the database table initialization command.
※Executing the command will delete & create operation_logs, operation_logs_hourly, operation_logs_daily, operation_logs_monthly tables.
※If you want to record up to microseconds, specify the --enable_micro option.
Append middleware to Application.php
※If you want to log all requests without using the option, please replace with OperationLogsSimpleMiddleware middleware.
Options.
| option name | option type | default | example | memo |
|---|---|---|---|---|
| mode | string | 'exclude' | 'include' | Only 'exclude' and 'include' allowed |
| exclude_urls | string array | [ '/debug-kit' ] | [ '/debug-kit', '/admin' ] | Exclude with prefix match |
| exclude_ips | string array | [] | [ '192.168', '::' ] | Exclude with prefix match |
| exclude_user_agents | string array | [] | [ 'Safari', 'Edge' ] | Exclude with broad match |
| include_urls | string array | [] | [ '/admin/top' ] | Include with prefix match |
| include_ips | string array | [] | [ '192.168.1.3' ] | Include with prefix match |
| include_user_agents | string array | [] | [ 'Firefox', 'Chrome' ] | Include with broad match |
※If 'mode' is 'exclude' the 'include_〇〇' option is ignored. (And vice versa)
CakePHP4.3以上のバージョンでPHPUnitテストを実施する場合
CakePHP4.3で実施されたFixtureのアップグレードに伴い、PHPUnitテストの際にスキーマファイルをロードする必要があります。
以下のような操作でOperationLogsプラグイン内に同梱するスキーマファイルをアプリケーション本体のschemaディレクトリにコピーすることができます。
Data summary commands.
daily_summaryコマンド、monthly_summaryコマンド、hourly_summaryコマンドがあります。
operation_logsテーブルのデータを元にクライアントIP、ユーザーエージェント、リクエストURLなどでグルーピングしたデータを集計します。
daily_summary command.
--target_ymdオプションで集計日を設定可能。
未指定のときは前日のデータを集計します。
データはoperation_logs_dailyテーブルに記録されます。
monthly_summary command.
--target_ymオプションで集計年月を6桁の数字で設定可能。
未指定の時は先月のデータを集計します。
データはoperation_logs_monthlyテーブルに記録されます。
hourly_summary command.
--target_ymdオプションで集計日を設定可能。
未指定の時は前日のデータを集計します。
1時間単位でデータを集計します。
データはoperation_logs_hourlyテーブルに記録されます。
