Para enviar tus registros de C# a Datadog, utiliza uno de los siguientes enfoques:

• Registra en un archivo y luego sigue ese archivo con tu Agente de Datadog.
• Habilita el registro sin agente.
• Usa el sumidero de Serilog.

Registro de seguimiento de archivos con el Agente de Datadog

El enfoque recomendado para la recolección de logs en C# es enviar tus logs a un archivo y luego tail ese archivo con tu Agente de Datadog. Esto permite que el Agente de Datadog enriquezca los logs con metadatos adicionales.

Datadog recomienda encarecidamente configurar tu biblioteca de registros para producir tus registros en formato JSON para evitar la necesidad de reglas de parseo personalizadas.

El registro de tipo file-tail soporta los siguientes frameworks:

• Serilog
• NLog
• log4net

Configura tu logger

PM> Install-Package Serilog.Sinks.File

// Instantiate the logger
var log = new LoggerConfiguration()  // using Serilog;

    // using Serilog.Formatting.Json;
    .WriteTo.File(new JsonFormatter(renderMessage: true), "log.json")

    // using Serilog.Formatting.Compact;
    // .WriteTo.File(new RenderedCompactJsonFormatter(), "log.json")

    .CreateLogger();

// An example
var position = new { Latitude = 25, Longitude = 134 };
var elapsedMs = 34;

log.Information("Processed {@Position} in {Elapsed:000} ms.", position, elapsedMs);

{
  "MessageTemplate": "Processed {@Position} in {Elapsed:000} ms.",
  "Level": "Information",
  "Timestamp": "2016-09-02T15:02:29.648Z",
  "Renderings": {"Elapsed": [{"Format": "000", "Rendering": "034"}]},
  "RenderedMessage":"Processed { Latitude: 25, Longitude: 134 } in 034 ms.",
  "Properties": {"Position": {"Latitude": 25, "Longitude": 134}, "Elapsed": 34}
}

{
  "@t": "2020-05-20T04:15:28.6898801Z",
  "@m": "Processed { Latitude: 25, Longitude: 134 } in 034 ms.",
  "@i": "d1eb2146",
  "Position": {"Latitude": 25, "Longitude": 134 },
  "Elapsed": 34
}

PM> Install-Package NLog

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <!--
  See https://github.com/nlog/nlog/wiki/Configuration-file
  for information on customizing logging rules and outputs.
   -->
  <targets async="true">
    <!-- Write logs as Json into a file -->
    <target name="json-file" xsi:type="File" fileName="application-logs.json">
      <layout xsi:type="JsonLayout">
        <attribute name="date" layout="${date:universalTime=true:format=o}" />
        <attribute name="level" layout="${level:upperCase=true}"/>
        <attribute name="message" layout="${message}" />
        <attribute name="exception" layout="${exception:format=ToString}" />
      </layout>
    </target>

  </targets>
  <rules>
    <!-- Log all events to the json-file target -->
    <logger name="*" writeTo="json-file" minlevel="Trace" />
  </rules>
</nlog>

using NLog;

namespace Datadog
{
    class Program
    {
        // Initialize a logger
        private static Logger logger = LogManager.GetCurrentClassLogger();

        static void Main(string[] args)
        {
            // Log a simple debug message
            logger.Debug("This is my first step");

            // your code continues here ...
        }
    }
}

PM> Install-Package log4net
PM> Install-Package log4net.Ext.Json

<?xml version="1.0" encoding="utf-8"?>
<configuration>

  <configSections>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
  </configSections>

  <log4net>
    <root>
      <level value="DEBUG" />
      <appender-ref ref="JsonFileAppender" />
    </root>
    <appender name="JsonFileAppender" type="log4net.Appender.FileAppender">
      <threshold value="DEBUG"/>
      <file value="application-logs.json" />
      <encoding type="System.Text.UTF8Encoding" />
      <appendToFile value="true" />
      <layout type="log4net.Layout.SerializedLayout, log4net.Ext.Json">
        <decorator type="log4net.Layout.Decorators.StandardTypesDecorator, log4net.Ext.Json" />
        <default />
        <!--explicit default members-->
        <remove value="ndc" />
        <remove value="message" />
        <!--remove the default preformatted message member-->
        <member value="message:messageobject" />
        <!--add raw message-->
      </layout>
    </appender>
  </log4net>

  <!-- The rest of your configuration starts here ... -->

using log4net;

namespace Datadog
{
    class Program
    {
        // Get the current class logger
        private static ILog logger = LogManager.GetLogger(typeof(Program));

        static void Main(string[] args)
        {

           // Load the configure fom App.config
           XmlConfigurator.Configure();

           // Log a simple debug message
           logger.Debug("This is my first debug message");

           // your code continues here ...
        }
    }
}

{
  "level": "DEBUG",
  "message": "This is my debug message",
  "date": "2016-05-24 15:53:35.7175",
  "appname": "Datadog.vshost.exe",
  "logger": "Datadog.Program",
  "thread": "10"
}

<param name="ConversionPattern" value="%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread] %logger %method:%line - %message%n" />

Configura el Agente de Datadog

Una vez que la recolección de registros esté habilitada, configura la recolección de registros personalizada para seguir tus archivos de registro y enviarlos a Datadog.

1. Crea una carpeta csharp.d/ en el conf.d/ directorio de configuración del Agente.

2. Crea un archivo conf.yaml en csharp.d/ con el siguiente contenido:

   init_config:
   
   instances:
   
   ##Log section
   logs:
   
     - type: file
       path: "<path_to_your_csharp_log>.log"
       service: <service_name>
       source: csharp
       sourcecategory: sourcecode
       # For multiline logs, if they start by the date with the format yyyy-mm-dd uncomment the following processing rule
       #log_processing_rules:
       #  - type: multi_line
       #    name: new_log_start_with_date
       #    pattern: \d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])
   

3. Asegúrate de que el usuario del Agent tenga permisos de acceso de lectura al archivo de registro.

4. Reinicia el Agent.

5. Ejecuta el subcomando de estado del Agent y busca csharp en la sección Checks para confirmar que los registros se envían correctamente a Datadog.

Si los registros están en formato JSON, Datadog automáticamente analiza los mensajes de registro para extraer los atributos de los registros. Utiliza el Explorador de Registros para ver y solucionar problemas en tus registros.

Conecta tu servicio a través de registros y trazas

Si APM está habilitado para esta aplicación, conecta tus registros y trazas añadiendo automáticamente los IDs de trazas, IDs de span, env, service, y version a tus registros siguiendo las instrucciones de APM .NET

Nota: Si el SDK de Datadog inyecta service en tus registros, anula el valor establecido en la configuración del agente.

Registro sin agente con APM

Es posible transmitir registros desde tu aplicación a Datadog directamente, sin realizar cambios en el código, utilizando la biblioteca de instrumentación automática de APM .NET. Este enfoque envía registros directamente a Datadog, por lo que no se beneficia de funciones como el enmascaramiento de datos sensibles que proporciona el Agente de Datadog. Por esa razón, recomendamos utilizar el seguimiento de las últimas líneas de archivos cuando sea posible, pero es útil en entornos donde esto no es posible (cuando se utiliza Azure App Service por ejemplo). Vale la pena mencionar que aún podrás confiar en las capacidades de enmascaramiento del lado del servidor realizadas por Sensitive Data Scanner.

El registro sin agente (también conocido como “envío directo de registros”) admite los siguientes marcos:

• Serilog (v1.0+)
• NLog (v2.1+)
• log4net (v1.0+)
• Microsoft.Extensions.Logging (2.0+)

No requiere modificar el código de tu aplicación, ni instalar dependencias adicionales en tu aplicación.

Configura el SDK de Datadog

El registro sin agente solo está disponible al usar APM con instrumentación automática. Para comenzar, instrumenta tu aplicación como se describe en los siguientes documentos:

• aplicaciones .NET Core/.NET 5+
• aplicaciones .NET Framework

Después de instalar, verifica que estás recibiendo trazas correctamente.

Habilita el registro sin agente

Para habilitar el registro sin agente, establece las siguientes variables de entorno:

DD_API_KEY

Tu clave de API de Datadog para enviar tus registros a Datadog.

DD_SITE

El nombre de tu sitio de Datadog. Elige uno de los siguientes ejemplos:
Ejemplo: datadoghq.com (US1), datadoghq.eu (EU), us3.datadoghq.com (US3), us5.datadoghq.com (US5), ap1.datadoghq.com (AP1), ap2.datadoghq.com (AP2), ddog-gov.com (US1-FED), us2.ddog-gov.com (US2-FED)
Predeterminado: datadoghq.com (US1)

DD_LOGS_INJECTION

Habilita conectar registros y trazas:
Predeterminado: true
Habilitado por defecto desde la versión 3.24.0 del Tracer.

DD_LOGS_DIRECT_SUBMISSION_INTEGRATIONS

Habilita el registro sin agente. Habilita para tu marco de registro configurando a Serilog, NLog, Log4Net o ILogger (para Microsoft.Extensions.Logging). Si estás utilizando múltiples marcos de registro, utiliza una lista de variables separadas por punto y coma.
Ejemplo: Serilog;Log4Net;NLog

Reinicie su aplicación después de configurar estas variables de entorno.

Configuración adicional

Puede personalizar aún más algunos aspectos de la recolección de registros sin agente utilizando las siguientes variables de entorno:

DD_LOGS_DIRECT_SUBMISSION_MINIMUM_LEVEL

Permite filtrar registros por nivel antes de enviarse a Datadog. Configure a uno de los siguientes valores: Verbose, Debug, Information, Warning, Error, Critical. Estos corresponden a los niveles equivalentes en los logging frameworks soportados.
Predeterminado: Information

DD_LOGS_DIRECT_SUBMISSION_HOST

Establezca el nombre del host asociado a los registros. Si no se proporciona, se intentará encontrar automáticamente el nombre del host.
Predeterminado: Determinado automáticamente

DD_LOGS_DIRECT_SUBMISSION_TAGS

Si se especifica, agrega todas las etiquetas indicadas a todos los tramos generados. Si no se proporciona, se utilizará DD_TAGS en su lugar.
Ejemplo: layer:api, team:intake Tenga en cuenta que el delimitador es una coma y un espacio: , .

Los siguientes valores de configuración generalmente no deben ser modificados, pero pueden establecerse si es necesario.

DD_LOGS_DIRECT_SUBMISSION_URL

Establece la URL donde se deben enviar los registros. Utiliza el dominio proporcionado en DD_SITE por defecto.
Predeterminado: :443 (based on DD_SITE)

DD_LOGS_DIRECT_SUBMISSION_SOURCE

Establece la regla de parseo para los registros enviados. Siempre debe establecerse en csharp, a menos que tenga un custom pipeline.
Predeterminado: csharp

DD_LOGS_DIRECT_SUBMISSION_MAX_BATCH_SIZE

Establece el número máximo de registros a enviar a la vez. Toma en cuenta los límites establecidos para la API.
Predeterminado: 1000

DD_LOGS_DIRECT_SUBMISSION_MAX_QUEUE_SIZE

Establece el número máximo de registros que se pueden mantener en la cola interna en un momento dado antes de descartar mensajes de registro.
Predeterminado: 100000

DD_LOGS_DIRECT_SUBMISSION_BATCH_PERIOD_SECONDS

Establece el tiempo de espera (en segundos) antes de verificar nuevos registros para enviar.
Predeterminado: 1

Si está utilizando la integración Microsoft.Extensions.Logging, puede filtrar los registros enviados a Datadog utilizando las capacidades estándar integradas en ILogger. Utilice la clave "Datadog" para identificar el proveedor de envío directo y establecer los niveles mínimos de registro para cada espacio de nombres. Por ejemplo, agregar lo siguiente a su appSettings.json evitaría enviar cualquier registro con un nivel inferior a Warning a Datadog. Introducido en el SDK de .NET v2.20.0.

{
  "Logging": {
    "Datadog": {
      "LogLevel": {
        "Microsoft.AspNetCore": "Warning"
      },
    }
  }
}

Registro sin agente con el Serilog sink

Si no es posible utilizar el seguimiento de las últimas líneas de archivos o el registro sin agente de APM, y está utilizando el framework Serilog, entonces puede usar el Serilog sink de Datadog para enviar registros directamente a Datadog.

Instale el Serilog sink de Datadog en su aplicación, que envía eventos y registros a Datadog. Por defecto, el sink reenvía los registros a través de HTTPS en el puerto 443. Ejecute el siguiente comando en la Consola del Administrador de Paquetes:

PM> Install-Package Serilog.Sinks.Datadog.Logs

Luego, inicialice el logger directamente en su aplicación. Asegúrese de agregar su <API_KEY>.

using (var log = new LoggerConfiguration()
    .WriteTo.DatadogLogs("<API_KEY>", configuration: new DatadogConfiguration(){ Url = "" })
    .CreateLogger())
{
    // Some code
}

Los nuevos registros ahora se envían directamente a Datadog.

Lectura Adicional

Documentación, enlaces y artículos útiles adicionales:

Cómo recolectar, personalizar y analizar registros de C#BLOG Conectando registros y trazas de .NETDOCUMENTACIÓN Aprende a procesar tus registrosDOCUMENTACIÓN Aprende más sobre el parseoDOCUMENTACIÓN Aprende a explorar tus registrosDOCUMENTACIÓN Realiza análisis de registrosDOCUMENTACIÓN Guía de solución de problemas de recolección de registrosPREGUNTAS FRECUENTES Entrada del glosario para "tail"GLOSARIO Paquete Serilog.Sinks.Datadog.LogsPAQUETE DE GITHUB