Skip to content

Commit

Permalink
docs: Change Stackdriver to Google Cloud
Browse files Browse the repository at this point in the history
And fix some typos, including in test code.
  • Loading branch information
amanda-tarafa committed Jun 4, 2021
1 parent 7e66b28 commit 7f5f89e
Show file tree
Hide file tree
Showing 15 changed files with 30 additions and 33 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,6 @@ public LoggingSnippetsTests()
_startTime = DateTime.UtcNow;
}

/// <summary>
/// Test for the GcpStackdriverLoggingConsoleUrl snippet.
/// </summary>
[Fact]
public void GetsLogViewingUrl()
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ namespace Google.Cloud.Diagnostics.AspNetCore
public static class ErrorReportingExceptionLoggerExtension
{
/// <summary>
/// Uses middleware that will report all uncaught exceptions to the Stackdriver
/// Uses middleware that will report all uncaught exceptions to the Google Cloud
/// Error Reporting API.
/// </summary>
/// <param name="app">The application builder. Must not be null.</param>
Expand All @@ -76,7 +76,7 @@ public static IApplicationBuilder UseGoogleExceptionLogging(this IApplicationBui

/// <summary>
/// Adds services for middleware that will report all uncaught exceptions to the
/// Stackdriver Error Reporting API.
/// Google Cloud Error Reporting API.
/// <para>
/// Can be used when running on Google App Engine or Google Compute Engine.
/// The Google Cloud Platform project to report errors to will detected from the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ namespace Google.Cloud.Diagnostics.AspNetCore
/// <summary>
/// Middleware that will, when invoked, call the next <see cref="RequestDelegate"/>,
/// catch any exception that it may throw, send that exception to the
/// Stackdriver Error Reporting API and rethrow the given exception.
/// Google Cloud Error Reporting API and rethrow the given exception.
/// </summary>
public sealed class ErrorReportingExceptionLoggerMiddleware
{
Expand All @@ -49,7 +49,7 @@ public ErrorReportingExceptionLoggerMiddleware(RequestDelegate next, IExceptionL

/// <summary>
/// Invokes the next <see cref="RequestDelegate"/>, catches any exception thrown,
/// reports the exception to the Stackdriver Error Reporting API and rethrows
/// reports the exception to the Google Cloud Error Reporting API and rethrows
/// the exception.
/// </summary>
public async Task Invoke(HttpContext httpContext)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ namespace Google.Cloud.Diagnostics.AspNetCore
#endif
{
/// <summary>
/// Google Cloud Error Reporting Logger. Reports exceptions to the Stackdriver Error Reporting API.
/// Google Cloud Error Reporting Logger. Reports exceptions to the Google Cloud Error Reporting API.
/// </summary>
///
/// <example>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ namespace Google.Cloud.Diagnostics.AspNetCore
#endif
{
/// <summary>
/// <see cref="ILogger"/> for Google Stackdriver Logging.
/// <see cref="ILogger"/> for Google Cloud Logging.
/// </summary>
///
/// <example>
Expand All @@ -48,7 +48,7 @@ namespace Google.Cloud.Diagnostics.AspNetCore
/// </example>
///
/// <remarks>
/// Logs to Google Stackdriver Cloud Logging.
/// Logs to Google Cloud Logging.
/// Docs: https://cloud.google.com/logging/docs/
/// </remarks>
/// <seealso cref="GoogleLoggerFactoryExtensions"/>
Expand Down Expand Up @@ -289,7 +289,7 @@ private void SetTraceAndSpanIfAny(LogEntry entry)

/// <summary>
/// For diagnostic purposes. Builds and returns the URL where the entries logged by
/// this <see cref="GoogleLogger"/> can be seen on the GCP Stackdriver Logging Console.
/// this <see cref="GoogleLogger"/> can be seen on the Google Cloud Logging Console.
/// </summary>
public Uri GetGcpConsoleLogsUrl()
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ namespace Google.Cloud.Diagnostics.AspNetCore
/// </example>
///
/// <remarks>
/// Logs to Google Stackdriver Cloud Logging.
/// Logs to Google Cloud Logging.
/// Docs: https://cloud.google.com/logging/docs/
/// </remarks>
/// <seealso cref="GoogleLogger"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ namespace Google.Cloud.Diagnostics.AspNetCore
#endif
{
/// <summary>
/// <see cref="ILoggerProvider"/> for Google Stackdriver Logging.
/// <see cref="ILoggerProvider"/> for Google Cloud Logging.
/// </summary>
public sealed class GoogleLoggerProvider : ILoggerProvider
{
Expand All @@ -44,7 +44,7 @@ public sealed class GoogleLoggerProvider : ILoggerProvider
private readonly IServiceProvider _serviceProvider;

/// <summary>
/// <see cref="ILoggerProvider"/> for Google Stackdriver Logging.
/// <see cref="ILoggerProvider"/> for Google Cloud Logging.
/// </summary>
/// <param name="consumer">The consumer to push logs to. Must not be null.</param>
/// <param name="logTarget">Where to log to. Must not be null.</param>
Expand All @@ -68,7 +68,7 @@ internal GoogleLoggerProvider(IConsumer<LogEntry> consumer, LogTarget logTarget,
}

/// <summary>
/// Create an <see cref="ILoggerProvider"/> for Google Stackdriver Logging.
/// Create an <see cref="ILoggerProvider"/> for Google Cloud Logging.
/// </summary>
/// <param name="serviceProvider">The service provider to resolve additional services from.
/// May be null, in which case additional services (such as custom labels) will not be used.</param>
Expand All @@ -86,7 +86,7 @@ public static GoogleLoggerProvider Create(IServiceProvider serviceProvider, stri
}

/// <summary>
/// Create an <see cref="ILoggerProvider"/> for Google Stackdriver Logging.
/// Create an <see cref="ILoggerProvider"/> for Google Cloud Logging.
/// </summary>
/// <param name="logTarget">Where to log to. Must not be null.</param>
/// <param name="serviceProvider">Optional, the service provider to resolve additional services from. May be null,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ namespace Google.Cloud.Diagnostics.AspNetCore
/// <summary>
/// Uses the Google Cloud Trace Middleware.
/// Traces the time taken for all subsequent delegates to run. The time taken
/// and metadata will be sent to the Stackdriver Trace API. Also allows for more
/// and metadata will be sent to the Google Cloud Trace API. Also allows for more
/// finely grained manual tracing.
/// </summary>
///
Expand Down Expand Up @@ -80,7 +80,7 @@ public static class CloudTraceExtension
{
/// <summary>
/// Uses middleware that will trace time taken for all subsequent delegates to run.
/// The time taken and metadata will be sent to the Stackdriver Trace API. To be
/// The time taken and metadata will be sent to the Google Cloud Trace API. To be
/// used with <see cref="AddGoogleTrace"/>,
/// </summary>
public static IApplicationBuilder UseGoogleTrace(this IApplicationBuilder app)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public CloudTraceMiddleware(
/// <summary>
/// Invokes the next <see cref="RequestDelegate"/> and traces the time
/// taken for the next delegate to run, reporting the results to the
/// Stackdriver Trace API.
/// Google Cloud Trace API.
/// </summary>
/// <param name="httpContext">The current HTTP context.</param>
/// <param name="traceContext">Trace information from the current request. Must not be null.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
using System.Runtime.CompilerServices;
using Xunit;

// Because of the Stackdriver limits on reading and writing entries.
// Because of the Google Cloud limits on reading and writing entries.
// This reduces the chances of exceeding the limits.
[assembly: CollectionBehavior(DisableTestParallelization = true)]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public void CreateConsumer_ErrorToLogsConsumer()
}

[Fact]
public void CreateConsumer_BufferdConsumer()
public void CreateConsumer_BufferedConsumer()
{
var bufferOptions = BufferOptions.SizedBuffer();
var eventTarget = EventTarget.ForLogging(_projectId, "test-log", _loggingClient);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public static ErrorReportingOptions Create(

/// <summary>
/// Creates an <see cref="ErrorReportingOptions"/> that will send error events to the
/// Stackdriver Logging API.
/// Google Cloud Logging API.
/// </summary>
/// <param name="projectId">Optional if running on Google App Engine or Google Compute Engine.
/// The Google Cloud Platform project ID. If running on GAE or GCE the project ID will be
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ namespace Google.Cloud.Diagnostics.Common
/// </summary>
public enum EventTargetKind
{
/// <summary>Stackdriver Error Logging API.</summary>
/// <summary>Google Cloud Error Logging API.</summary>
Logging
}

Expand Down Expand Up @@ -55,9 +55,9 @@ public sealed class EventTarget
public MonitoredResource MonitoredResource { get; private set; }

/// <summary>
/// Creates a new <see cref="EventTarget"/> instance that will report to the Stackdriver Logging API.
/// The events are then automatically propagated to the Stackdriver Error Logging API from the
/// Stackdriver Logging API.
/// Creates a new <see cref="EventTarget"/> instance that will report to the Google Cloud Logging API.
/// The events are then automatically propagated to the Google Cloud Error Logging API from the
/// Google Cloud Logging API.
/// </summary>
/// <remarks>
/// For more information see "Formatting Log Error Messages"
Expand All @@ -80,9 +80,9 @@ public static EventTarget ForLogging(string projectId = null, string logName = L
}

/// <summary>
/// Creates a new <see cref="EventTarget"/> instance that will report to the Stackdriver Logging API.
/// The events are then automatically propagated to the Stackdriver Error Logging API from the
/// Stackdriver Logging API.
/// Creates a new <see cref="EventTarget"/> instance that will report to the Google Cloud Logging API.
/// The events are then automatically propagated to the Google Cloud Error Logging API from the
/// Google Cloud Logging API.
/// </summary>
/// <remarks>
/// For more information see "Formatting Log Error Messages"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@
namespace Google.Cloud.Diagnostics.Common
{
/// <summary>
/// An <see cref="IConsumer{T}"/> that will send received logs to the Stackdriver Logging API.
/// An <see cref="IConsumer{T}"/> that will send received logs to the Google Cloud Logging API.
/// </summary>
internal sealed class GrpcLogConsumer : IConsumer<LogEntry>
{
private LoggingServiceV2Client _client;

/// <param name="client">The logging client that will push logs to the Stackdriver Logging API.</param>
/// <param name="client">The logging client that will push logs to the Google Cloud Logging API.</param>
public GrpcLogConsumer(LoggingServiceV2Client client)
{
_client = GaxPreconditions.CheckNotNull(client, nameof(client));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@
namespace Google.Cloud.Diagnostics.Common
{
/// <summary>
/// A <see cref="IConsumer{TraceProto}"/> that will send received traces to the Stackdriver Trace API.
/// A <see cref="IConsumer{TraceProto}"/> that will send received traces to the Google Cloud Trace API.
/// </summary>
internal sealed class GrpcTraceConsumer : IConsumer<TraceProto>
{
private readonly TraceServiceClient _client;

/// <param name="client">The trace client that will push traces to the Stackdriver Trace API.</param>
/// <param name="client">The trace client that will push traces to the Google Cloud Trace API.</param>
internal GrpcTraceConsumer(TraceServiceClient client)
{
_client = GaxPreconditions.CheckNotNull(client, nameof(client));
Expand Down

0 comments on commit 7f5f89e

Please sign in to comment.