컨텍스트 (Context)

• 소개
  • 작동 방식
• 컨텍스트 캡처하기
  • 스택
• 컨텍스트 가져오기
  • 항목 존재 여부 확인
• 컨텍스트 제거하기
• 숨겨진 컨텍스트
• 이벤트
  • 비활성화(Dehydrating)
  • 활성화(Hydrated)

소개 (Introduction)

Laravel의 "컨텍스트" 기능은 애플리케이션 내에서 실행되는 요청, 작업(job), 명령어 전반에 걸쳐 정보를 캡처하고, 가져오고, 공유할 수 있게 해줍니다. 이렇게 캡처된 정보는 애플리케이션에서 작성하는 로그에도 포함되어, 로그가 기록되기 전에 실행된 코드의 수행 이력에 대한 깊은 통찰을 제공하며, 분산 시스템 전체의 실행 흐름을 추적할 수 있게 합니다.

작동 방식

Laravel의 컨텍스트 기능을 이해하는 가장 좋은 방법은 내장된 로깅 기능을 활용하여 실제로 작동하는 예를 보는 것입니다. 시작하려면 Context 파사드를 사용해 컨텍스트에 정보 추가하기부터 해봅니다. 이 예에서는 모든 들어오는 요청마다 요청 URL과 고유한 추적 ID를 컨텍스트에 추가하는 미들웨어를 사용합니다:

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Context;
use Illuminate\Support\Str;
use Symfony\Component\HttpFoundation\Response;

class AddContext
{
    /**
     * Handle an incoming request.
     */
    public function handle(Request $request, Closure $next): Response
    {
        Context::add('url', $request->url());
        Context::add('trace_id', Str::uuid()->toString());

        return $next($request);
    }
}

컨텍스트에 추가된 정보는 요청 전반에서 작성되는 모든 로그 항목에 메타데이터로 자동 추가됩니다. 컨텍스트를 메타데이터로 덧붙이면, 개별 로그 항목에 전달되는 정보와 Context를 통해 공유되는 정보를 구분할 수 있습니다. 예를 들어, 다음과 같이 로그를 작성한다고 가정해봅시다:

Log::info('User authenticated.', ['auth_id' => Auth::id()]);

작성된 로그에는 auth_id가 포함되지만, 동시에 컨텍스트의 url과 trace_id도 메타데이터로 포함됩니다:

User authenticated. {"auth_id":27} {"url":"https://example.com/login","trace_id":"e04e1a11-e75c-4db3-b5b5-cfef4ef56697"}

컨텍스트에 추가된 정보는 큐에 디스패치된 작업에도 적용됩니다. 예를 들어, 컨텍스트에 정보를 추가한 후에 ProcessPodcast 작업을 큐에 디스패치한다고 가정해봅시다:

// In our middleware...
Context::add('url', $request->url());
Context::add('trace_id', Str::uuid()->toString());

// In our controller...
ProcessPodcast::dispatch($podcast);

작업이 디스패치될 때, 현재 컨텍스트에 저장된 모든 정보가 캡처되어 작업과 함께 공유됩니다. 그리고 작업이 실행되는 동안 캡처된 정보가 다시 현재 컨텍스트로 "활성화"됩니다. 만약 작업의 handle 메서드가 로그를 작성한다면:

class ProcessPodcast implements ShouldQueue
{
    use Queueable;

    // ...

    /**
     * Execute the job.
     */
    public function handle(): void
    {
        Log::info('Processing podcast.', [
            'podcast_id' => $this->podcast->id,
        ]);

        // ...
    }
}

해당 로그 항목에는 작업을 디스패치했던 요청 시점에 컨텍스트에 추가된 정보도 포함됩니다:

Processing podcast. {"podcast_id":95} {"url":"https://example.com/login","trace_id":"e04e1a11-e75c-4db3-b5b5-cfef4ef56697"}

이 문서에서는 Laravel 컨텍스트의 내장된 로깅 관련 기능에 집중했지만, 이후 문서에서는 HTTP 요청과 큐 작업 경계를 넘어 정보를 공유할 수 있는 방법과, 로그 항목에 기록되지 않는 숨겨진 컨텍스트 데이터를 추가하는 방법도 설명할 것입니다.

컨텍스트 캡처하기 (Capturing Context)

Context 파사드의 add 메서드를 사용해 현재 컨텍스트에 정보를 저장할 수 있습니다:

use Illuminate\Support\Facades\Context;

Context::add('key', 'value');

여러 항목을 한꺼번에 추가하려면, 연관 배열을 add 메서드에 전달하면 됩니다:

Context::add([
    'first_key' => 'value',
    'second_key' => 'value',
]);

add 메서드는 같은 키가 이미 존재하면 기존 값을 덮어씁니다. 만약 키가 존재하지 않을 경우에만 추가하고 싶다면 addIf 메서드를 사용하십시오:

Context::add('key', 'first');

Context::get('key');
// "first"

Context::addIf('key', 'second');

Context::get('key');
// "first"

컨텍스트는 지정한 키의 값을 증가시키거나 감소시키는 편리한 메서드도 제공합니다. 이 두 메서드는 최소 하나의 인수(추적할 키)를 받으며, 두 번째 인수로 증가 또는 감소할 값을 지정할 수 있습니다:

Context::increment('records_added');
Context::increment('records_added', 5);

Context::decrement('records_added');
Context::decrement('records_added', 5);

조건부 컨텍스트

when 메서드는 주어진 조건에 따라 컨텍스트에 데이터를 추가할 때 사용됩니다. 조건이 true일 때 호출되는 첫 번째 클로저, false일 때 호출되는 두 번째 클로저를 전달할 수 있습니다:

use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Context;

Context::when(
    Auth::user()->isAdmin(),
    fn ($context) => $context->add('permissions', Auth::user()->permissions),
    fn ($context) => $context->add('permissions', []),
);

범위 지정 컨텍스트

scope 메서드는 지정된 콜백 함수 실행 동안 컨텍스트를 일시적으로 변경하고, 콜백 실행이 끝난 후 원래 상태로 복원하는 방법을 제공합니다. 콜백 실행 중 병합할 추가 데이터는 두 번째와 세 번째 인수로 전달할 수 있습니다.

use Illuminate\Support\Facades\Context;
use Illuminate\Support\Facades\Log;

Context::add('trace_id', 'abc-999');
Context::addHidden('user_id', 123);

Context::scope(
    function () {
        Context::add('action', 'adding_friend');

        $userId = Context::getHidden('user_id');

        Log::debug("Adding user [{$userId}] to friends list.");
        // Adding user [987] to friends list.  {"trace_id":"abc-999","user_name":"taylor_otwell","action":"adding_friend"}
    },
    data: ['user_name' => 'taylor_otwell'],
    hidden: ['user_id' => 987],
);

Context::all();
// [
//     'trace_id' => 'abc-999',
// ]

Context::allHidden();
// [
//     'user_id' => 123,
// ]

[!WARNING] 스코프 내부에서 컨텍스트 안 객체를 수정하면, 해당 변경이 스코프 외부에도 반영됩니다.

스택

컨텍스트는 스택이라는 기능을 제공하는데, 이는 추가된 순서대로 데이터를 저장하는 리스트입니다. push 메서드를 호출해 스택에 정보를 추가할 수 있습니다:

use Illuminate\Support\Facades\Context;

Context::push('breadcrumbs', 'first_value');

Context::push('breadcrumbs', 'second_value', 'third_value');

Context::get('breadcrumbs');
// [
//     'first_value',
//     'second_value',
//     'third_value',
// ]

스택은 요청 중 발생한 일련의 이벤트처럼, 시간 순으로 발생한 기록 정보를 캡처하는 데 유용합니다. 예를 들어, 쿼리가 실행될 때마다 쿼리 SQL과 소요 시간을 튜플로 스택에 푸시하는 이벤트 리스너를 생성할 수 있습니다:

use Illuminate\Support\Facades\Context;
use Illuminate\Support\Facades\DB;

// In AppServiceProvider.php...
DB::listen(function ($event) {
    Context::push('queries', [$event->time, $event->sql]);
});

stackContains와 hiddenStackContains 메서드를 사용해 스택에 값이 존재하는지 확인할 수 있습니다:

if (Context::stackContains('breadcrumbs', 'first_value')) {
    //
}

if (Context::hiddenStackContains('secrets', 'first_value')) {
    //
}

두 메서드는 두 번째 인수로 클로저도 받아, 값 비교 작업을 더 세밀하게 제어할 수 있습니다:

use Illuminate\Support\Facades\Context;
use Illuminate\Support\Str;

return Context::stackContains('breadcrumbs', function ($value) {
    return Str::startsWith($value, 'query_');
});

컨텍스트 가져오기 (Retrieving Context)

Context 파사드의 get 메서드를 사용해 컨텍스트에서 정보를 가져올 수 있습니다:

use Illuminate\Support\Facades\Context;

$value = Context::get('key');

only와 except 메서드는 컨텍스트에서 특정 부분 집합만 가져올 때 사용합니다:

$data = Context::only(['first_key', 'second_key']);

$data = Context::except(['first_key']);

pull 메서드를 사용하면 컨텍스트에서 값을 가져오면서 동시에 제거할 수 있습니다:

$value = Context::pull('key');

만약 컨텍스트 데이터가 스택에 저장되어 있다면 pop 메서드로 스택의 마지막 항목을 꺼낼 수 있습니다:

Context::push('breadcrumbs', 'first_value', 'second_value');

Context::pop('breadcrumbs');
// second_value

Context::get('breadcrumbs');
// ['first_value']

remember와 rememberHidden 메서드는 특정 정보를 컨텍스트에서 가져오고, 요청한 정보가 없으면 주어진 클로저가 반환하는 값으로 설정하는 데 사용됩니다:

$permissions = Context::remember(
    'user-permissions',
    fn () => $user->permissions,
);

컨텍스트에 저장된 모든 정보를 가져오려면 all 메서드를 호출하십시오:

$data = Context::all();

항목 존재 여부 확인

has와 missing 메서드를 사용해 주어진 키에 컨텍스트 값이 저장되어 있는지 확인할 수 있습니다:

use Illuminate\Support\Facades\Context;

if (Context::has('key')) {
    // ...
}

if (Context::missing('key')) {
    // ...
}

has 메서드는 저장된 값이 무엇이든 간에 true를 반환합니다. 따라서 null 값이어도 키가 존재하는 것으로 간주됩니다:

Context::add('key', null);

Context::has('key');
// true

컨텍스트 제거하기 (Removing Context)

forget 메서드를 사용해 현재 컨텍스트에서 특정 키와 값을 제거할 수 있습니다:

use Illuminate\Support\Facades\Context;

Context::add(['first_key' => 1, 'second_key' => 2]);

Context::forget('first_key');

Context::all();

// ['second_key' => 2]

여러 키를 한꺼번에 제거하려면 배열을 forget 메서드에 전달하면 됩니다:

Context::forget(['first_key', 'second_key']);

숨겨진 컨텍스트 (Hidden Context)

컨텍스트는 "숨겨진" 데이터를 저장하는 기능도 제공합니다. 이 숨겨진 정보는 로그에 추가되지 않으며, 앞서 설명한 데이터 조회 메서드로 접근할 수 없습니다. 숨겨진 컨텍스트 데이터와 상호작용하려면 다른 메서드 집합을 사용해야 합니다:

use Illuminate\Support\Facades\Context;

Context::addHidden('key', 'value');

Context::getHidden('key');
// 'value'

Context::get('key');
// null

숨겨진 컨텍스트 관련 메서드는 비숨김 메서드와 동일한 기능을 제공합니다:

Context::addHidden(/* ... */);
Context::addHiddenIf(/* ... */);
Context::pushHidden(/* ... */);
Context::getHidden(/* ... */);
Context::pullHidden(/* ... */);
Context::popHidden(/* ... */);
Context::onlyHidden(/* ... */);
Context::exceptHidden(/* ... */);
Context::allHidden(/* ... */);
Context::hasHidden(/* ... */);
Context::missingHidden(/* ... */);
Context::forgetHidden(/* ... */);

이벤트 (Events)

컨텍스트는 컨텍스트의 활성화(hydration)와 비활성화(dehydration) 과정에 훅을 걸 수 있도록 두 가지 이벤트를 발행합니다.

예를 들어, 애플리케이션 미들웨어에서 들어오는 HTTP 요청의 Accept-Language 헤더를 기반으로 app.locale 설정 값을 지정한다고 가정해봅시다. 컨텍스트 이벤트를 활용하면 이 값을 요청 동안 캡처하고, 큐에서 복원하여, 큐에서 실행되는 알림 등이 올바른 app.locale 설정을 사용할 수 있도록 할 수 있습니다. 이 과정에서 숨겨진 데이터를 함께 사용합니다. 아래 문서를 통해 구현 예를 확인할 수 있습니다.

비활성화

작업이 큐에 디스패치될 때마다, 컨텍스트의 데이터는 "비활성화"되어 작업 페이로드와 함께 캡처됩니다. Context::dehydrating 메서드를 통해 비활성화 과정 동안 호출될 클로저를 등록할 수 있습니다. 이 클로저 내에서 큐 작업과 함께 공유할 데이터를 수정할 수 있습니다.

일반적으로 AppServiceProvider 클래스의 boot 메서드에서 dehydrating 콜백을 등록합니다:

use Illuminate\Log\Context\Repository;
use Illuminate\Support\Facades\Config;
use Illuminate\Support\Facades\Context;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Context::dehydrating(function (Repository $context) {
        $context->addHidden('locale', Config::get('app.locale'));
    });
}

[!NOTE] dehydrating 콜백 안에서 Context 파사드 사용은 권장하지 않습니다. 현재 프로세스의 컨텍스트가 변경될 수 있으므로, 반드시 콜백에 전달된 저장소 인스턴스에서만 작업하세요.

활성화

큐에 디스패치된 작업이 실행되기 시작할 때, 작업과 함께 공유된 컨텍스트가 현재 컨텍스트로 "활성화"됩니다. Context::hydrated 메서드를 통해 활성화 과정에서 호출될 클로저를 등록할 수 있습니다.

일반적으로 AppServiceProvider 클래스의 boot 메서드에서 hydrated 콜백을 등록합니다:

use Illuminate\Log\Context\Repository;
use Illuminate\Support\Facades\Config;
use Illuminate\Support\Facades\Context;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Context::hydrated(function (Repository $context) {
        if ($context->hasHidden('locale')) {
            Config::set('app.locale', $context->getHidden('locale'));
        }
    });
}

[!NOTE] hydrated 콜백 내에서 Context 파사드를 직접 사용하지 말고, 반드시 콜백에 전달된 저장소 인스턴스를 통해만 작업하세요.