バックエンドエラーの追跡

概要

Datadog でまだログを収集していない場合は、ログドキュメントを参照してログを設定してください。source タグ (言語指定) が適切に構成されていることを確認してください。Datadog では、Agent ベースのログ収集の設定を推奨しています。

セットアップ

Python、Java、Ruby などの言語では、ログの source タグが正しく設定されていれば、追加の設定は必要ありません。必要な属性は全て自動的にタグ付けされ、Datadog に送信されます。

C#、.NET、Go、Node.js などのバックエンド言語については、各セクションのコード例で、エラーログを適切に構成し、ログの error.stack に必要なスタックトレースをアタッチする方法を示しています。

もし、スタックトレースを Datadog に送信しているが、error.stack にない場合、ジェネリックログリマッパーをセットアップして、スタックトレースを Datadog の正しい属性にリマップすることが可能です。

課題でのインラインコードスニペットを構成するには、ソースコードインテグレーションを設定します。Error Tracking for Logs でコードスニペットを追加する場合、APM は必要ありません。エンリッチメントタグとリンク先のリポジトリは、どちらも同じです。

エラー追跡の属性

Datadog 内には、専用の UI 表示を持つ特定の属性があります。エラー追跡でこれらの関数を有効にするには、以下の属性名を使用します。

属性説明
error.stack実際のスタックトレース
error.messageスタックトレースに含まれるエラーメッセージ
error.kindエラーのタイプまたは「種類」(“Exception” や “OSError” など)

注: インテグレーションパイプラインは、デフォルトのログライブラリパラメーターをこれらの属性に再マップし、スタックトレースをパースまたはトレースバックして、自動的に error.message と error.kind を抽出しようとします。

詳しくは、ソースコード属性の完全なドキュメントをご覧ください。

C# と .NET

    C# のログ収集の設定をしていない場合は、C# ログ収集ドキュメントを参照してください。

    キャッチした例外を自分でログに残すには、オプションで以下を使用できます。

    var log = new LoggerConfiguration()
    .WriteTo.File(new JsonFormatter(renderMessage: true), "log.json")
    .Enrich.WithExceptionDetails()
    .CreateLogger();
try {
  // ...
} catch (Exception ex) {
  // log 呼び出しの最初の引数として例外を渡す
  log.Error(ex, "an exception occurred");
}

    C# のログ収集の設定をしていない場合は、C# ログ収集ドキュメントを参照してください。

    キャッチした例外を自分でログに残すには、オプションで以下を使用できます。

    private static Logger log = LogManager.GetCurrentClassLogger();

static void Main(string[] args)
{
  try {
    // ...
  } catch (Exception ex) {
    // ログ呼び出しの第二引数として例外を渡す
    log.ErrorException("an exception occurred", ex);
  }
}

    C# のログ収集の設定をしていない場合は、C# ログ収集ドキュメントを参照してください。

    キャッチした例外を自分でログに残すには、オプションで以下を使用できます。

    class Program
{
  private static ILog logger = LogManager.GetLogger(typeof(Program));

  static void Main(string[] args)
  {
    try {
      // ...
    } catch (Exception ex) {
      // ログ呼び出しの第二引数として例外を渡す
      log.Error("an exception occurred", ex);
    }
  }
}

    Go

    Logrus

    Go のログ収集の設定をしていない場合は、Go ログ収集ドキュメントを参照してください。

    キャッチした例外を自分でログに残すには、オプションで以下を使用できます。

    // https://github.com/pkg/errors の場合
type stackTracer interface {
    StackTrace() errors.StackTrace
}

type errorField struct {
  Kind    string `json:"kind"`
  Stack   string `json:"stack"`
  Message string `json:"message"`
}

func ErrorField(err error) errorField {
    var stack string
    if serr, ok := err.(stackTracer); ok {
        st := serr.StackTrace()
        stack = fmt.Sprintf("%+v", st)
        if len(stack) > 0 && stack[0] == '\n' {
            stack = stack[1:]
        }
    }
    return errorField{
        Kind: reflect.TypeOf(err).String(),
        Stack: stack,
        Message: err.Error(),
    }
}


log.WithFields(log.Fields{
    "error": ErrorField(err)
}).Error("an exception occurred")

    Java (パース済み)

    Java のログ収集を設定していない場合は、Java ログ収集ドキュメントを参照してください。ログに source:java というタグが付けられていることを確認してください。

      キャッチした例外を自分でログに残すには、オプションで以下を使用できます。

      Logger logger = LogManager.getLogger("HelloWorld");
try {
  // ...
} catch (Exception e) {
  // ログ呼び出しの最後の引数として例外を渡す
  logger.error("an exception occurred", e)
}

      キャッチした例外を自分でログに残すには、オプションで以下を使用できます。

      Logger logger = LoggerFactory.getLogger(NameOfTheClass.class);
try {
  // ...
} catch (Exception e) {
  // ログ呼び出しの最後の引数として例外を渡す
  logger.error("an exception occurred", e)
}

      Node.js

      Winston (JSON)

      Node.js のログ収集の設定をしていない場合は、Node.js ログ収集ドキュメントを参照してください。

      キャッチした例外を自分でログに残すには、オプションで以下を使用できます。

      try {
  // ...
} catch (e) {
  logger.error("an exception occurred", {
    error: {
      message: e.message,
      stack: e.stack
    }
  });
}

      Python

      ロギング

      Python のログ収集を設定していない場合は、Python ログ収集ドキュメントを参照してください。ログに source:python というタグが付けられていることを確認してください。

      キャッチした例外を自分でログに残すには、オプションで以下を使用できます。

      try:
  // ...
except:
  logging.exception('an exception occurred')

      Ruby on Rails

      カスタムロガーフォーマッター

      Ruby on Rails のログ収集の設定をしていない場合は、Ruby on Rails ログ収集ドキュメントを参照してください。

      手動でエラーを記録するには、JSON を使ってフォーマッターを作成し、例外値を正しいフィールドにマッピングします。

      require 'json'
require 'logger'

class JsonWithErrorFieldFormatter < ::Logger::Formatter
    def call(severity, datetime, progname, message)
        log = {
            timestamp: "#{datetime.to_s}",
            level: severity,
        }

        if message.is_a?(Hash)
            log = log.merge(message)
        elsif message.is_a?(Exception)
            log['message'] = message.inspect
            log['error'] = {
                kind: message.class,
                message: message.message,
                stack: message.backtrace.join("\n"),
            }
        else
            log['message'] = message.is_a?(String) ? message : message.inspect
        end

        JSON.dump(log) + "\n"
    end
end

      そして、それをロガーで使用します。

      logger = Logger.new(STDOUT)
logger.formatter = JsonWithErrorFieldFormatter.new

      Lograge を使用する場合は、フォーマットされたエラーログを送信するように設定することもできます。

      Rails.application.configure do
    jsonLogger = Logger.new(STDOUT) # STDOUT または Agent の構成に応じたファイル
    jsonLogger.formatter = JsonWithErrorFieldFormatter.new

    # Rails のデフォルトの TaggedLogging ロガーを json フォーマッター付きの新規ロガーに置き換えます。
    # TaggedLogging はより複雑な json 形式のメッセージと互換性がありません
    config.logger = jsonLogger

    # Lograge の構成
    config.lograge.enabled = true
    config.lograge.formatter = Lograge::Formatters::Raw.new

    # ログの着色を無効にします
    config.colorize_logging = false

    # 例外のロギングを正しいフィールドに構成します
    config.lograge.custom_options = lambda do |event|
        if event.payload[:exception_object]
            return {
                level: 'ERROR',
                message: event.payload[:exception_object].inspect,
                error: {
                    kind: event.payload[:exception_object].class,
                    message: event.payload[:exception_object].message,
                    stack: event.payload[:exception_object].backtrace.join("\n")
                }
            }
        end
    end
end

      その他の参考資料

      お役に立つドキュメント、リンクや記事:

      Datadog Error Tracking で、アプリケーションの問題を解明GITHUB more more エラートラッキングエクスプローラーについてドキュメント more more