Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve log message written by selfdiagnostics to file. #4219

Merged

Conversation

cijothomas
Copy link
Member

@cijothomas cijothomas marked this pull request as ready for review February 23, 2023 02:02
@cijothomas cijothomas requested a review from a team as a code owner February 23, 2023 02:02
@@ -30,7 +30,7 @@ namespace OpenTelemetry.Internal
/// </summary>
internal class SelfDiagnosticsConfigRefresher : IDisposable
{
public static readonly byte[] MessageOnNewFile = Encoding.UTF8.GetBytes("Successfully opened file.\n");
public static readonly byte[] MessageOnNewFile = Encoding.UTF8.GetBytes("If you are seeing this message, it means that the OpenTelemetry SDK has successfully created the log file used to write self-diagnostic logs. This file will be appended with logs as they appear. If you see this line, but nothing more, try changing the the LogLevel to show logs of lower severities.\n");
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you are seeing this message, it means that the OpenTelemetry SDK has successfully created the log file

^ this was suggested by AI :)

@codecov
Copy link

codecov bot commented Feb 23, 2023

Codecov Report

Merging #4219 (244fa38) into main (7139c7a) will decrease coverage by 0.05%.
The diff coverage is 100.00%.

❗ Current head 244fa38 differs from pull request most recent head e8438d7. Consider uploading reports for the commit e8438d7 to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #4219      +/-   ##
==========================================
- Coverage   85.57%   85.53%   -0.05%     
==========================================
  Files         291      291              
  Lines       11398    11398              
==========================================
- Hits         9754     9749       -5     
- Misses       1644     1649       +5     
Impacted Files Coverage Δ
...lemetry/Internal/SelfDiagnosticsConfigRefresher.cs 86.53% <100.00%> (ø)
...porter.OpenTelemetryProtocol/OtlpMetricExporter.cs 72.72% <0.00%> (-13.64%) ⬇️
...tation/OpenTelemetryProtocolExporterEventSource.cs 85.00% <0.00%> (-10.00%) ⬇️
src/OpenTelemetry/BatchExportProcessor.cs 82.24% <0.00%> (-1.87%) ⬇️
...ter.ZPages/Implementation/ZPagesActivityTracker.cs 100.00% <0.00%> (+2.85%) ⬆️
...ZPages/Implementation/ZPagesExporterEventSource.cs 62.50% <0.00%> (+6.25%) ⬆️

@cijothomas cijothomas merged commit 814206d into open-telemetry:main Feb 23, 2023
@cijothomas
Copy link
Member Author

No product change, but a useful improvement to the opening message. Merging for 1.4

@cijothomas cijothomas deleted the cijothomas/betteropeningmessage branch February 23, 2023 05:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Self-diagnostics improvement
5 participants