Para enviar tus logs de C# a Datadog, usa una de las siguientes estrategias:

• Registrar los logs en un archivo y luego supervísarlo con tu Datadog Agent.
• Habilitar el registro de logs sin Agent.
• Usar el receptor Serilog.

Registro de logs en un archivo para supervisarlo con el Datadog Agent

Para recopilar logs de C#, lo más recomendable es que tus logs se registren en un archivo que luego puedas supervisar con tu Datadog Agent. De esta forma, el Datadog Agent enriquecerá los logs con metadatos adicionales.

Datadog recomienda que configures tu biblioteca de registro para que genere tus logs en formato JSON y así evitar la necesidad de crear reglas de parseo personalizadas.

El registro de logs en un archivo para supervisarlo es compatible con los siguientes marcos:

• Serilog
• NLog
• log4net

Configurar el registrador

PM> Install-Package Serilog.Sinks.File

// Crea una instancia del registrador
var log = new LoggerConfiguration()  // mediante Serilog;

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

    // mediante Serilog.Formatting.Compact;
    // .WriteTo.File(RenderedCompactJsonFormatter() nuevo, "log.json")

    .CreateLogger();

// Un ejemplo
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">

  <!--
  Consulta https://github.com/nlog/nlog/wiki/Configuration-file
  para obtener información sobre cómo personalizar las reglas y resultados del registro de logs.
   -->
  <targets async="true">
    <!-- Escribe logs como JSON en un archivo -->
    <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>
    <!-- Registra todos los eventos en el archivo JSON de destino -->
    <logger name="*" writeTo="json-file" minlevel="Trace" />
  </rules>
</nlog>

using NLog;

namespace Datadog
{
    class Program
    {
        // Inicia un registrador
        private static Logger logger = LogManager.GetCurrentClassLogger();

        static void Main(string[] args)
        {
            // Registra en un log un mensaje de depuración simple
            logger.Debug("This is my first step");

            // tu código continúa aquí...
        }
    }
}

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 />
        <!--miembros predeterminados explícitos-->
        <remove value="ndc" />
        <remove value="message" />
        <!--elimina el miembro del mensaje preformateado de manera predetermina-->
        <member value="message:messageobject" />
        <!--añade un mensaje sin procesar-->
      </layout>
    </appender>
  </log4net>

  <!-- El resto de tu configuración empieza aquí... -->

using log4net;

namespace Datadog
{
    class Program
    {
        // Obtén el registrador de clases actual
        private static ILog logger = LogManager.GetLogger(typeof(Program));

        static void Main(string[] args)
        {

           // Carga la configuración desde App.config
           XmlConfigurator.Configure();

           // Registra en un log un mensaje de depuración simple
           logger.Debug("Este es mi primer mensaje de depuración");

           // tu código continúa aquí...
        }
    }
}

{
  "level": "DEBUG",
  "message": "Este es mi mensaje de depuración",
  "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" />

Configurar el Datadog Agent

Una vez que se haya habilitado la recopilación de logs, configura la recopilación de logs personalizada para supervisar tus archivos de log y enviarlos a Datadog.

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

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 log.

4. Reinicia el Agent.

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

Si los logs están en formato JSON, Datadog parsea los mensajes del log de forma automática para extraer sus atributos. Utiliza el Log Explorer para ver tus logs y solucionar problemas relacionados.

Conectar los servicios a logs y trazas

Si tienes APM habilitado para esta aplicación, conecta tus logs y trazas al añadir de manera automática los IDs de traza, IDs de tramo (span), env, service y version a tus logs mediante las siguientes instrucciones de APM para .NET

Nota: Si el rastreador de APM inyecta service en tus logs, este reemplazará al valor definido en la configuración del Agent.

Registro de logs sin Agent con APM

Gracias a la biblioteca de instrumentación automática de APM y .NET, es posible crear un flujo de logs desde tu aplicación directamente a Datadog, sin hacer cambios en el código. De esta forma, los logs se envían directamente a Datadog, por lo que no se beneficia de funciones como la limpieza de datos confidenciales que ofrece el Datadog Agent. Por esta razón, recomendamos que registres los logs en un archivo que puedas supervisar siempre que sea posible, aunque es cierto que resulta útil en entornos no compatibles con este método (por ejemplo, si usas Azure App Service). Cabe destacar que podrás seguir limpiando los datos confidenciales en el servidor con la ayuda de Sensitive Data Scanner.

El registro de logs sin Agent (también denominado «envío directo de logs») es compatible con los siguientes marcos:

• Serilog (versión 1.0 o posterior)
• NLog (versión 2.1 o posterior)
• log4net (versión 1.0 o posterior)
• Microsoft.Extensions.Logging (2.0 o posterior)

No es necesario que modifiques el código de tu aplicación ni que instales dependencias adicionales.

Configurar la biblioteca de APM

El registro de logs sin Agent solo está disponible cuando se usa APM con la instrumentación automática. Para empezar, instrumenta tu aplicación según se describe en los siguientes documentos:

• Aplicaciones de .NET Core/.NET 5 o posterior
• Aplicaciones de .NET Framework

Después de la instalación, verifica que estés recibiendo trazas correctamente.

Habilitar el registro de logs sin Agent

Para habilitar el registro de logs sin Agent, define las siguientes variables de entorno:

DD_API_KEY

Tu clave de API de Datadog para enviar tus logs 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), ddog-gov.com (US1-FED)
Predeterminado: datadoghq.com (US1)

DD_LOGS_INJECTION

Habilita la conexión de logs y trazas:
Predeterminado: true
Habilitado de manera predeterminada al usar el registro de logs sin Agent a partir de la versión 2.7.0 del rastreador.

DD_LOGS_DIRECT_SUBMISSION_INTEGRATIONS

Permite el registro de logs sin Agent. Habilita esta funcionalidad en tu marco de registro de logs al establecer Serilog, NLog, Log4Net o ILogger (para Microsoft.Extensions.Logging). Si usas varios marcos de registro de logs, usa una lista de variables separadas por punto y coma.
Ejemplo: Serilog;Log4Net;NLog

Reinicia tu aplicación después de establecer las variables de entorno.

Configuración adicional

Puedes personalizar algunos aspectos de la recopilación de logs sin Agent mediante las siguientes variables de entorno:

DD_LOGS_DIRECT_SUBMISSION_MINIMUM_LEVEL

Permite filtrar los logs por nivel antes de enviarlos a Datadog. Define uno de los siguientes valores: Verbose, Debug, Information, Warning, Error, Critical. Estos corresponden a los niveles equivalentes en los marcos de registro de logs compatibles.
Predeterminado: Information

DD_LOGS_DIRECT_SUBMISSION_HOST

Define el nombre del equipo host asociado a los logs. Si no se indica, el nombre de host se intentará encontrar de manera automática.
Predeterminado: se determina de manera automática

DD_LOGS_DIRECT_SUBMISSION_TAGS

Si se especifica, añade todas las etiquetas (tags) detalladas a los tramos generados. De lo contrario, se usa DD_TAGS.
Ejemplo: layer:api, team:intake Ten en cuenta que se usa una coma y un espacio como separador: , .

Por lo general, los siguientes valores de configuración no se modifican, pero pueden definirse si fuera necesario.

DD_LOGS_DIRECT_SUBMISSION_SOURCE

Define la regla de parseo para los logs enviados. Siempre debería definirse como csharp, a menos que tengas un pipeline personalizado.
Predeterminado: csharp

DD_LOGS_DIRECT_SUBMISSION_MAX_BATCH_SIZE

Define el número máximo de logs que se pueden enviar de una vez. Tiene en cuenta los límites establecidos para la API.
Predeterminado: 1000

DD_LOGS_DIRECT_SUBMISSION_MAX_QUEUE_SIZE

Define el número máximo de logs que se pueden mantener en la cola interna antes de empezar a eliminar mensajes de log.
Predeterminado: 100000

DD_LOGS_DIRECT_SUBMISSION_BATCH_PERIOD_SECONDS

Define el tiempo de espera (en segundos) antes de comprobar si hay logs nuevos para enviar.
Predeterminado: 1

Si usas la integración Microsoft.Extensions.Logging, puedes filtrar los logs enviados a Datadog con ayuda de las funcionalidades estándar integradas en ILogger. Usa la clave "Datadog" para identificar al proveedor de envío directo, y establece los niveles mínimos del log para un espacio de nombres. Por ejemplo, si añades lo siguiente a tu appSettings.json, evitarías que se envíen logs con un nivel inferior a Warning a Datadog. Disponible a partir de la versión 2.20.0 de la biblioteca del rastreador de .NET.

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

Registro de logs sin Agent con el receptor Serilog

Si no es posible usar el registro de logs en un archivo para supervisarlo ni el registro de logs sin Agent de APM, y usas un marco Serilog, puedes usar el receptor Serilog de Datadog para enviar logs directamente a Datadog.

Instala el receptor Serilog de Datadog en tu aplicación, que envía eventos y logs a Datadog. De manera predeterminada, el receptor reenvía los logs a través de HTTPS en el puerto 443. Ejecuta el siguiente comando en la consola del administrador de paquetes:

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

Luego, inicia el registrador directamente en tu aplicación. Asegúrate de añadir tu <API_KEY>.

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

var config = new DatadogConfiguration(url: "intake.logs.datadoghq.com", port: 10516, useSSL: true, useTCP: true);
using (var log = new LoggerConfiguration()
    .WriteTo.DatadogLogs(
        "<API_KEY>",
        source: "<SOURCE_NAME>",
        service: "<SERVICE_NAME>",
        host: "<HOST_NAME>",
        tags: new string[] {"<TAG_1>:<VALUE_1>", "<TAG_2>:<VALUE_2>"},
        configuration: config
    )
    .CreateLogger())
{
    // Inserta código
}

var config = new DatadogConfiguration(url: "tcp-intake.logs.datadoghq.eu", port: 443, useSSL: true, useTCP: true);
using (var log = new LoggerConfiguration()
    .WriteTo.DatadogLogs(
        "<API_KEY>",
        source: "<SOURCE_NAME>",
        service: "<SERVICE_NAME>",
        host: "<HOST_NAME>",
        tags: new string[] {"<TAG_1>:<VALUE_1>", "<TAG_2>:<VALUE_2>"},
        configuration: config
    )
    .CreateLogger())
{
    // Inserta código
}

Ahora los logs nuevos se envían directamente a Datadog.

Referencias adicionales

Más enlaces, artículos y documentación útiles:

Cómo recopilar, personalizar y analizar logs de C#BLOG Conectar logs y trazas (traces) de .NETDOCUMENTACIÓN Aprende a procesar tus logsDOCUMENTACIÓN Obtén más información sobre el parseoDOCUMENTACIÓN Aprende a explorar tus logsDOCUMENTACIÓN Realizar análisis de logsDOCUMENTACIÓN Guía para solucionar problemas relacionados con la recopilación de logsFAQ Entrada de glosario para "tail" (cola)GLOSARIO Paquete Serilog.Sinks.Datadog.LogsPAQUETE DE GITHUB