Cómo configurar Stackdriver Trace para C# ASP.NET

Stackdriver Trace se puede habilitar para aplicaciones ASP.NET Framework mediante la biblioteca cliente de Google.Cloud.Diagnostics.AspNet para C#.

Instala la biblioteca cliente

Para usar la biblioteca cliente de Google.Cloud.Diagnostics.AspNet en Visual Studio, sigue estos pasos:

  1. Haz clic derecho en tu solución de Visual Studio y selecciona Administrar paquetes de NuGet para la solución.

  2. Selecciona la casilla de verificación Incluir lanzamiento anticipado.

  3. Busca y, luego, instala el paquete denominado Google.Cloud.Diagnostics.AspNet.

Cómo configurar la biblioteca cliente

Después de instalar Google.Cloud.Diagnostics.AspNet, completa los siguientes pasos para habilitar y configurar Trace:

  1. Agrega el siguiente elemento XML a la sección <appSettings> del archivo Web.config de tu aplicación y actualiza YOUR-GOOGLE-PROJECT-ID para que sea el número o ID del proyecto:

    <add key="projectId" value="YOUR-GOOGLE-PROJECT-ID" />
  2. Agrega lo siguiente con la directiva al archivo Global.asax.cs de tu aplicación:

    using Google.Cloud.Diagnostics.AspNet;
    using Google.Cloud.Diagnostics.Common;
    
  3. En la clase WebApiApplication del archivo Global.asax.cs, agrega el siguiente bloque de código Init para inicializar el seguimiento:

    public override void Init()
    {
        string projectId = ConfigurationManager.AppSettings["projectId"];
        // ...
        base.Init();
        TraceConfiguration traceConfig = TraceConfiguration
            .Create(bufferOptions: BufferOptions.NoBuffer());
        CloudTrace.Initialize(this, projectId, traceConfig);
    }
    

Trace ya está configurado para realizar el muestreo de las solicitudes HTTP que recibe tu aplicación. Con el fin de iniciar los seguimientos desde tu aplicación, consulta aplicación de ejemplo para ASP.NET Framework.

Ejecución en Google Cloud Platform

No es necesario que proporciones credenciales de autenticación para las instancias que se ejecutan en Google Cloud Platform, siempre y cuando el nivel de acceso a la API de Stackdriver Trace esté habilitado en esa instancia. Sin embargo, recomendamos establecer el nivel de acceso más amplio posible para la instancia y, luego, usar Cloud Identity and Access Management a fin de restringir el acceso.

Entorno flexible de App Engine

En el entorno flexible de App Engine, el nivel de acceso a la API de Stackdriver Trace está habilitado de forma predeterminada, y la biblioteca cliente de Google.Cloud.Diagnostics.AspNet se puede usar sin proporcionar credenciales ni un ID del proyecto.

Entorno estándar de App Engine

Actualmente, C# no es compatible con el entorno estándar de App Engine.

GKE

En GKE, agrega el nivel de acceso de OAuth trace.append cuando crees el clúster:

gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/trace.append

No puedes cambiar los niveles de acceso del clúster una vez creado.

Compute Engine

Para las instancias de VM de Compute Engine, debes habilitar explícitamente el nivel de acceso a la API de Stackdriver Trace trace.append para cada instancia de VM. Cuando crees una instancia nueva con Google Cloud Platform Console, selecciona los siguientes valores en la sección Identidad y acceso a la API en el panel Crear una instancia:

  1. Selecciona Cuenta de servicio predeterminada de Compute Engine para Cuenta de servicio.
  2. Selecciona Permitir el acceso total a todas las API de Cloud para Niveles de servicio.

Para usar una cuenta que no sea la cuenta de servicio predeterminada de Compute Engine, consulta las secciones Cómo crear y habilitar cuentas de servicio para instancias y Cómo ejecutar de manera local y en otro lugar. Lo importante es que la cuenta de servicio que uses tenga la función de Agente de Cloud Trace.

Cómo ejecutar de manera local y en otro lugar

Para ejecutar Stackdriver Trace fuera de GCP, debes proporcionar tu ID del proyecto de GCP y las credenciales de la cuenta de servicio correspondiente directamente en la biblioteca cliente de Google.Cloud.Diagnostics.AspNet. Si deseas obtener más información, consulta Cómo proporcionar credenciales a la aplicación.

ID del proyecto

Proporciona un ID del proyecto a la biblioteca cliente de Google.Cloud.Diagnostics.AspNet. Para ello, ingresa el ID del proyecto en el archivo Web.config como se describe antes en el paso 1 de la sección Cómo configurar la biblioteca cliente.

Credenciales

Las bibliotecas cliente de GCP usan las credenciales predeterminadas de la aplicación (ADC) para encontrar las credenciales de tu aplicación. Las credenciales para la biblioteca cliente de Google.Cloud.Diagnostics.AspNet se proporcionan mediante la configuración de la variable de entorno GOOGLE_APPLICATION_CREDENTIALS:

Linux/macOS

    export GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key

Windows

    set GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key

PowerShell:

    $env:GOOGLE_APPLICATION_CREDENTIALS="path-to-your-service-accounts-private-key"

Aplicación de ejemplo de Stackdriver Trace para ASP.NET Framework

public class TraceController : Controller
{
    // This incoming HTTP request should be captured by Trace.
    public ActionResult Index()
    {
        using (CloudTrace.Tracer.StartSpan(nameof(Index)))
        {
            string url = "https://www.googleapis.com/discovery/v1/apis";
            var response = TraceOutgoing(url);
            ViewData["text"] = response.Result.ToString();
            return View();
        }
    }

    public async Task<string> TraceOutgoing(string url)
    {
        // Manually trace a specific operation.
        using (CloudTrace.Tracer.StartSpan("get-api-discovery-doc"))
        {
            using (var httpClient = new HttpClient())
            {
                // This outgoing HTTP request should be captured by Trace.
                using (var response = await httpClient.GetAsync(url)
                    .ConfigureAwait(false))
                {
                    return await response.Content.ReadAsStringAsync();
                }
            }
        }
    }
}

Cómo ver los seguimientos

Después de la implementación, puedes ver los seguimientos en el lector de seguimiento de GCP Console.

Ir a la página del Lector de seguimiento

¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...

Si necesitas ayuda, visita nuestra página de asistencia.