You can enable Trace for ASP.NET core applications
by using the
Google.Cloud.Diagnostics.AspNetCore
client library for C#.
Installing the client library
Follow the instructions at nuget.org to install the library.
Configuring the client library
After the
Google.Cloud.Diagnostics.AspNetCore
client library is installed, complete the following
steps to enable and configure Trace:
Add the following
using
directives to your application'sStartup.cs
file:Set the Google Cloud project ID that is passed to the
Google.Cloud.Diagnostics.AspNetCore
client library by entering your Google Cloud project ID in theappsettings.json
file. In the following sample, replaceYOUR-GOOGLE-PROJECT-ID
with your Google Cloud project ID or number:Create a new file named
StackdriverOptions.cs
with the following content:Create or edit the
ConfigureServices
method in your application'sStartup.cs
file so that it callsservices.AddGoogleTrace()
:Edit the
Configure
method in your application'sStartup.cs
file and callapp.UseGoogleTrace()
before callingapp.UseStaticFile()
andapp.UseMvc()
.
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 core.
Configuring your platform
You can use Cloud Trace on Google Cloud and other platforms.
Running on Google Cloud
When your application is running on Google Cloud, you don't need to provide authentication credentials in the form of a service account to the client library. However, you do need to ensure that your Google Cloud platform has the Cloud Trace API access scope enabled.
For the following configurations, the default access-scope settings enable the Cloud Trace API:
- App Engine flexible environment
Google Kubernetes Engine (GKE)
Compute Engine
If you use custom access scopes, then you must ensure that
Cloud Trace API access scope
is enabled. For gcloud
users, specify access scopes using the --scopes
flag
and include the trace.append
Cloud Trace API access scope.
For example, to create a GKE cluster with only
the Cloud Trace API enabled, do the following:
gcloud container clusters create example-cluster-name --scopes=https://www.googleapis.com/auth/trace.append
Running locally and elsewhere
If your application is running outside of Google Cloud, then you must provide authentication credentials in the form of a service account to the client library. The service account must contain the Cloud Trace agent role. For instructions, see Creating a service account.
Google Cloud client libraries use
Application Default Credentials (ADC) to find your
application's credentials. You provide these credentials
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 core
Viewing the traces
After deployment, you can view the traces in the Cloud Console Trace Viewer.
Troubleshooting
For information on troubleshooting issues with Cloud Trace, go to the Troubleshooting page.
Resources
- GitHub:
Google.Cloud.Diagnostics.AspNetCore
- NuGet:
Google.Cloud.Diagnostics.AspNetCore
package - Source code
- GitHub issue tracker
- Stack Overflow