Ruby: 컨텍스트에서 로그 구성

이것은 가장 간단한 접근 방식이며, 로그 전달자 설정에 대한 액세스 권한이나 관심이 없는 개발자 또는 앱 컨텍스트에서 로그 및 기타 연결 메타데이터의 힘을 확인하려는 계정에 탁월한 선택입니다. 많은 오버 헤드.

이 옵션을 사용하면 로그에 span.id , trace.id , hostname , entity.guid 및 entity.name 가 포함됩니다. 이러한 속성은 로그를 스팬, 추적 및 기타 원격 분석에 자동으로 연결하므로 문제를 더 쉽게 해결할 수 있습니다.

로그 전달 기능이 있는 에이전트 버전( Ruby 에이전트 8.6.0 이상 )을 설치하고 전달을 활성화하도록 구성을 업데이트하기만 하면 됩니다.

newrelic.yml:

application_logging:
  forwarding:
    enabled: true

환경 변수:

NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED=true

이 옵션은 향후 에이전트 버전에서 기본적으로 켜져 있을 수 있습니다.

선택적 조정:

이 기능이 활성화되면 1분마다 New Relic에 전송되는 최대 로그 수를 제어할 수 있습니다. 기본값은 10,000입니다. 60초 동안 10,000개 이상의 로그가 수신되면 로그 샘플링이 시작됩니다.

더 많은 로그를 수신하려면 더 높은 숫자로 설정하십시오. 더 적은 수의 로그를 수신하려면 더 낮은 숫자로 설정하십시오. 100,000까지의 모든 정수가 유효합니다.

newrelic.yml:

application_logging:
  forwarding:
    max_samples_stored: 10000

환경 변수:

NEW_RELIC_APPLICATION_LOGGING_FORWARDING_MAX_SAMPLES_STORED: 10000

기존 로그 전달 솔루션이 있고 컨텍스트에서 자동 로그를 사용하도록 에이전트를 업데이트하는 경우 수동 로그 전달기를 비활성화해야 합니다 . 그렇지 않으면 앱에서 이중 로그 라인을 전송합니다. 계정에 따라 이중 청구가 발생할 수 있습니다. 자세한 내용은 절차에 따라 특정 로그 전달자 를 비활성화하십시오.

이미 마음에 드는 로그 포워더가 있습니까? 우리는 당신을 덮었습니다! 언어 에이전트는 자동 로그인 컨텍스트 기능에 대한 액세스를 제공하는 데 필요한 연결 메타데이터로 로그를 장식할 수 있습니다.

이 옵션은 에이전트 내 전달과 함께 사용하면 안 됩니다. 에이전트 내 전달이 활성화된 상태에서 외부 로그 전달자 를 사용하여 New Relic에 로그를 전송하면 로그가 New Relic에 최대 두 번 전송됩니다. 계정에 따라 이중 청구가 발생할 수 있습니다.

이 옵션은 수동 로그 데코레이팅 포맷터 와 함께 사용하면 안 됩니다. 코드베이스에 수동 포맷터에 대한 참조가 있는 경우 이 옵션을 활성화하기 전에 제거하십시오.

1. 이 옵션을 사용하려면 에이전트 내 전달 구성 옵션을 비활성화해야 합니다.

   newrelic.yml:

   application_logging:
      forwarding:
        enabled: false

   카피

2. 구성에서 로그 데코레이션을 활성화한 다음 에이전트를 다시 시작하여 로그 데코레이션을 시작합니다.

   newrelic.yml:

   application_logging:
     local_decorating:
       enabled: true

   카피

   환경 변수:

   NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED=true

   카피

   우리의 데코레이터는 모든 로그 메시지에 entity.guid , entity.name , hostname , trace.id 및 span.id 5가지 속성을 추가합니다. 예시:

   This is my log message. NR-LINKING|{entity.guid}|{hostname}|{trace.id}|{span.id}|{entity.name}|

   카피

   로그가 트랜잭션 외부에서 발생했거나 애플리케이션 컨텍스트에 적용할 수 없는 경우 일부 속성은 비어 있을 수 있습니다.

   수동 데코레이션 포맷터( NewRelic::Agent::Logging::DecoratingFormatter )보다 이 옵션을 사용하는 것이 좋습니다.

언어 에이전트가 로그를 전달하고 장식할 수 있기 전에는 NewRelic::Agent::Logging::DecoratingFormatter 을 사용하여 연결 메타데이터를 전송하도록 애플리케이션을 업데이트하여 컨텍스트에서 로그를 활성화할 수 있었습니다.

이 옵션은 계속 지원되지만 더 이상 권장되지 않습니다. 이 접근 방식을 사용하는 방법에 대한 지침 은 컨텍스트 옵션에서 수동 로그인을 참조하세요.

또한 이 방법을 사용하려면 컨텍스트에서 로그를 활성화하기 전에 로그 전달자를 설치해야 합니다. 로그 전달자가 없는 경우 New Relic UI는 인프라 에이전트 를 사용하라는 메시지를 표시합니다.

기존 로그 전달 솔루션을 사용하기로 결정하고 나중에 컨텍스트에서 자동 로그를 사용하도록 에이전트를 업데이트하기로 결정한 경우 수동 로그 전달기를 비활성화해야 합니다 . 그렇지 않으면 앱에서 이중 로그 라인을 전송합니다. 계정에 따라 이중 청구가 발생할 수 있습니다. 자세한 내용은 절차에 따라 특정 로그 전달자 를 비활성화하십시오.

Rails 로깅은 두 가지 구성 요소에 의해 제어됩니다.

• 설정하여 사용자 정의할 수 있는 로거 config.logger

• config.log_formatter 을(를) 설정하여 사용자 정의할 수 있는 로그 포맷터

  대부분의 경우 Rails 애플리케이션에서 config.log_formatter 을 DecoratingFormatter 로 설정하여 컨텍스트에서 로그를 구성해야 합니다. Rails 구성에 대한 자세한 정보는 rubyonrails.org 문서 를 참조하십시오.

  애플리케이션 구성에서 newrelic_rpm 을 요구하고 다음 줄을 추가합니다.

  module ________
    class Application < Rails::Application
  
    ...
  
    config.log_formatter = ::NewRelic::Agent::Logging::DecoratingFormatter.new
    end
  end

  카피

  이 구성은 로그 메시지에 New Relic 포맷터를 사용하지만 나머지 구성은 다른 Rails 설정에서 제공합니다.

New Relic의 장식 로거는 다음 보석과 호환되지 않는 것으로 알려져 있습니다.

• 벌채 반출
• 시맨틱 로거
• rails_stdout_logger
• rails_12factor

log_formatter 옵션을 설정해도 요구 사항이 충족되지 않으면 전체 Rails 로거를 New Relic 로거의 인스턴스로 교체하십시오. 다음과 같이 로거의 생성자에 매개변수를 제공합니다.

module ________
  class Application < Rails::Application

    ...

    config.logger = ::NewRelic::Agent::Logging::DecoratingLogger.new(
    "log/application.log", #etc...
    )
  end
end

비 Rails 애플리케이션의 경우 다음과 같이 Ruby 표준 ::Logger 대신 DecoratingLogger 을 사용합니다.

logger = ::NewRelic::Agent::Logging::DecoratingLogger.new(
  'log/application.log', #etc...
)
...

logger.info(...)

DecoratingLogger 은 Ruby 표준 ::Logger 에 대한 드롭인 대체입니다. 생성자는 동일한 매개변수를 허용합니다.

lograge gem 을 사용하여 이 확장을 구성하려면 이 문서의 Ruby on Rails 구성에 대한 표준 절차를 따르십시오. lograge gem에는 추가 구성이 필요하지 않습니다.

다른 로깅 구현 또는 자체 사용자 정의 로거와 함께 로깅 확장 프로그램을 사용하려면 DecoratingFormatter 을 사용하십시오. 예를 들어:

module ________
  class Application < Rails::Application

    ...

    config.logger = ::YourCustomLoggerImplementation.new(
      $stdout,
      formatter: ::NewRelic::Agent::Logging::DecoratingFormatter.new
    )
  end
end