Setting up Stackdriver Trace for C# ASP.NET

Beta

This is a beta release of the Google.Cloud.Diagnostics.AspNet client library for C# . These libraries might be changed in backward-incompatible ways and are not subject to any SLA or deprecation policy.

You can enable Stackdriver Trace for ASP.NET Framework applications by using the Google.Cloud.Diagnostics.AspNet client library for C#.

Installing the client library

To use the Google.Cloud.Diagnostics.AspNet client library in Visual Studio, do the following:

1. In Visual Studio, right-click your solution and select Manage Nuget packages for solution.

2. Select the Include prerelease checkbox.

3. Search for and install the package named Google.Cloud.Diagnostics.AspNet .

For more information, see Google.Cloud.Diagnostics.AspNet .

Configuring the client library

After the Google.Cloud.Diagnostics.AspNet is installed, complete the following steps to enable and configure Trace:

1. Add the following XML element to the <appSettings> section your application's Web.config file and update YOUR-GOOGLE-PROJECT-ID to be your project ID or number:

   View on GitHub Feedback

   <add key="projectId" value="YOUR-GOOGLE-PROJECT-ID" />

2. Add the following using directives to your application's Global.asax.cs file:

   View on GitHub Feedback

   
   using Google.Cloud.Diagnostics.AspNet;
   using Google.Cloud.Diagnostics.Common;
   

3. In the Global.asax.cs file's WebApiApplication class, add the following Init code block to initialize trace:

   View on GitHub Feedback

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

Trace is now configured to sample the HTTP requests received by your application. To initiate traces from your application, see sample application for ASP.NET Framework.

Running on Google Cloud Platform

You don't need to provide authentication credentials for instances running on Google Cloud Platform, provided Stackdriver Trace API access scope is enabled on that instance. However, we recommend setting the broadest possible access scope for your instance and then using Cloud Identity and Access Management to restrict access.

App Engine flexible environment

On App Engine flexible environment, the Stackdriver Trace API access scope is enabled by default, and the Google.Cloud.Diagnostics.AspNet client library can be used without providing credentials or a project ID.

App Engine standard environment

On App Engine standard, C# isn't currently supported.

GKE

On GKE, add the trace.append OAuth access scope when creating the cluster:

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

You cannot change the access scopes of a cluster after creation.

Compute Engine

For Compute Engine VM instances, you need to explicitly enable the trace.append Stackdriver Trace API access scope for each VM instance. When creating a new instance through the Google Cloud Platform Console, select the following values in the Identity and API access section of the Create an instance panel:

1. Select Compute Engine default service account for Service account
2. Select Allow full access to all Cloud APIs for Access Scopes

To use something other than the Compute Engine default service account see the Creating and enabling service accounts for instances and Running locally and elsewhere sections. The important thing is that the service account you use has the Cloud Trace Agent role.

Running locally and elsewhere

To run Stackdriver Trace outside of GCP you must supply your GCP project ID and appropriate service account credentials directly to Google.Cloud.Diagnostics.AspNet client library . For more information, see Providing credentials to your application.

Project ID

Provide a project ID to the Google.Cloud.Diagnostics.AspNet client library by entering your project ID into the Web.config file as described in Configuring the client library section.

Credentials

GCP client libraries use Application default credentials (ADC) to find your application's credentials. You provide credentials to the Google.Cloud.Diagnostics.AspNet client library by setting the GOOGLE_APPLICATION_CREDENTIALS environment variable:

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"

Sample Trace application for ASP.NET Framework

View on GitHub Feedback

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();
                }
            }
        }
    }
}

Viewing the traces

After deployment, you can view the traces in the GCP Console Trace Viewer.

Go to the Trace Viewer page