Datadog でまだログを収集していない場合は、ログドキュメント を参照してログを設定してください。source タグ (言語指定) が適切に構成されていることを確認してください。Datadog では、Agent ベースのログ収集の設定を推奨しています。
For languages such as Python , Java , and Ruby , no additional configuration is needed if the source tag in your logs is configured correctly. All required attributes are automatically tagged and sent to Datadog.
C# 、.NET 、Go 、Node.js などのバックエンド言語については、各セクションのコード例で、エラーログを適切に構成し、ログの error.stack に必要なスタックトレースをアタッチする方法を示しています。
もし、スタックトレースを Datadog に送信しているが、error.stack にない場合、ジェネリックログリマッパー をセットアップして、スタックトレースを Datadog の正しい属性にリマップすることが可能です。
課題でのインラインコードスニペットを構成するには、ソースコードインテグレーション を設定します。Error Tracking for Logs でコードスニペットを追加する場合、APM は必要ありません。エンリッチメントタグとリンク先のリポジトリは、どちらも同じです。
To enable Error Tracking, logs must include the following attributes:
Either an error.kind or error.stack field. Note : if using error.stack, it must be a valid stack trace. A status level of ERROR, CRITICAL, ALERT, or EMERGENCY. The remaining attributes listed below are optional, but their presence improves error grouping.
Specific attributes have a dedicated UI display within Datadog. To enable these functionalities for Error Tracking, use the following attribute names:
属性 説明 error.stack実際のスタックトレース error.messageスタックトレースに含まれるエラーメッセージ error.kindエラーのタイプまたは「種類」(“Exception” や “OSError” など)
注 : インテグレーションパイプラインは、デフォルトのログライブラリパラメーターをこれらの属性に再マップし、スタックトレースをパースまたはトレースバックして、自動的に error.message と error.kind を抽出しようとします。
詳しくは、ソースコードと属性ドキュメント をご覧ください。
C# のログ収集の設定をしていない場合は、C# ログ収集ドキュメント を参照してください。
キャッチした例外を自分でログに残すには、オプションで以下を使用できます。
var log = new LoggerConfiguration ()
. WriteTo . File ( new JsonFormatter ( renderMessage : true ), "log.json" )
. Enrich . WithExceptionDetails ()
. CreateLogger ();
try {
// ...
} catch ( Exception ex ) {
// pass exception as first argument of log call
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 のログ収集の設定をしていない場合は、Go ログ収集ドキュメント を参照してください。
キャッチした例外を自分でログに残すには、オプションで以下を使用できます。
// for 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 ログ収集ドキュメント を参照してください。ログに 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 のログ収集の設定をしていない場合は、Node.js ログ収集ドキュメント を参照してください。
キャッチした例外を自分でログに残すには、オプションで以下を使用できます。
try {
// ...
} catch (e) {
logger.error( "an exception occurred" , {
error: {
message: e.message,
stack: e.stack
}
});
}
Copy
If you have not set up log collection for PHP, see the PHP Log Collection documentation .
キャッチした例外を自分でログに残すには、オプションで以下を使用できます。
try {
// ...
} catch ( \Exception $e ) {
$logger -> error ( 'An error occurred' , [
'error.message' => $e -> getMessage (),
'error.kind' => get_class ( $e ),
'error.stack' => $e -> getTraceAsString (),
]);
}
Python のログ収集を設定していない場合は、Python ログ収集ドキュメント を参照してください。ログに source:python というタグが付けられていることを確認してください。
キャッチした例外を自分でログに残すには、オプションで以下を使用できます。
try :
// ...
except :
logging . exception ( 'an exception occurred' )
If you have not set up log collection for Ruby on Rails, see the Ruby on Rails Log Collection documentation .
To manually log an error, create a formatter using JSON and map the exception values to the correct fields:
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
And use it in your logger:
logger = Logger . new ( STDOUT )
logger . formatter = JsonWithErrorFieldFormatter . new
If you use Lograge , you can also set it up to send formatted error logs:
Rails . application . configure do
jsonLogger = Logger . new ( STDOUT ) # STDOUT or file depending on your agent configuration
jsonLogger . formatter = JsonWithErrorFieldFormatter . new
# Replacing Rails default TaggedLogging logger with a new one with the json formatter.
# TaggedLogging is incompatible with more complex json format messages
config . logger = jsonLogger
# Lograge config
config . lograge . enabled = true
config . lograge . formatter = Lograge :: Formatters :: Raw . new
# Disables log coloration
config . colorize_logging = false
# Configure logging of exceptions to the correct fields
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
