Download the PHP package khovanskiy/yii2-request-id without Composer

On this page you can find all versions of the php package khovanskiy/yii2-request-id. 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?

Example code of khovanskiy/yii2-request-id

Informations about the package yii2-request-id

Yii2 Request ID

Yii2 PHP License

Yii2 Request ID — это удобный компонент для фреймворка Yii2, который автоматически генерирует и обрабатывает уникальные идентификаторы запросов (Request ID). Эти идентификаторы помогают отслеживать и логировать запросы как в веб-приложениях, так и в консольных командах, обеспечивая лучшую трассировку и отладку.

Содержание

  1. Особенности
  2. Установка
  3. Настройка
  4. Использование
  5. Примеры
  6. Пользовательские генераторы Request ID
  7. Требования
  8. Лицензия
  9. Авторы
  10. Поддержка

Особенности

Требования

Шаг 1: Установка через Composer

Для установки пакета выполните следующую команду в корневой директории вашего проекта Yii2 Advanced:

Установка локального пакета (опционально)

Если вы разрабатываете пакет локально и хотите подключить его без публикации, выполните следующие шаги:

  1. Добавьте репозиторий в composer.json основного проекта:

Примечание: Убедитесь, что путь "../yii2-request-id" указывает на директорию вашего локального пакета.

  1. Установите пакет с указанием ветки разработки:

Важно: Если в вашем пакете используется нестабильная версия (dev-main), убедитесь, что в composer.json основного проекта установлено "prefer-stable": true.

Настройка

После установки необходимо настроить компонент в вашем приложении Yii2.

Шаг 1: Конфигурация Yii2

Откройте конфигурационный файл вашего приложения (common/config/main.php, backend/config/main.php или frontend/config/main.php в зависимости от структуры вашего проекта) и добавьте следующие настройки:

Пояснения:

Шаг 2: Настройка composer.json (для локальной установки)

Если вы используете локальную установку пакета, убедитесь, что в composer.json вашего основного проекта прописаны правильные настройки автозагрузки и репозитория:

Примечание: Если вы изменили minimum-stability, убедитесь, что она соответствует вашим требованиям.

Использование

После настройки компонент автоматически начнёт генерировать Request ID для каждого запроса и консольной команды. Вы можете получить доступ к текущему Request ID через сервис RequestIdService.

Доступ к Request ID

Получение Request ID в консольных командах

При выполнении консольных команд Request ID будет автоматически сгенерирован и выведен в консоль, а также записан в логи.

Примеры

Веб-приложение

При каждом HTTP-запросе:

  1. Компонент проверяет наличие заголовка X-Request-ID.
  2. Если заголовок отсутствует, генерируется новый Request ID.
  3. Request ID сохраняется в Yii::$app->params['request_id'].
  4. В ответ добавляется заголовок X-Request-ID с текущим Request ID.
  5. В логах записываются входящий запрос и его Request ID.

Консольная команда

При запуске команды:

  1. Генерируется новый Request ID.
  2. Request ID выводится в консоль и сохраняется в Yii::$app->params['request_id'].
  3. В логах фиксируется начало и завершение выполнения команды с соответствующим Request ID.

Пользовательские генераторы Request ID

Вы можете использовать собственные генераторы Request ID, реализовав интерфейс RequestIdGenerator.

Шаг 1: Создайте класс генератора

Шаг 2: Зарегистрируйте генератор в контейнере

В конфигурационном файле (main.php) замените стандартный генератор на ваш собственный:

Требования

Лицензия

Этот проект распространяется под лицензией BSD-3-Clause.

Авторы

Поддержка

Если у вас возникли вопросы или вы хотите предложить улучшения, пожалуйста, создайте issue на GitHub: https://github.com/khovanskiy5/Yii2-Request-Id/issues

Спасибо за использование Yii2 Request ID! Надеемся, что этот компонент поможет вам в улучшении трассировки и логирования ваших приложений на Yii2.

All versions of yii2-request-id with dependencies

PHP Build Version
Package Version
Requires yiisoft/yii2 Version ~2.0.45
yiisoft/yii2-bootstrap5 Version ~2.0.2
yidas/yii2-bower-asset Version ^2.0
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 khovanskiy/yii2-request-id contains the following files

Loading the files please wait ....