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

Mark logs signal as stable API/SDK #2229

Merged
merged 24 commits into from
Aug 1, 2023

Conversation

ThomsonTan
Copy link
Contributor

@ThomsonTan ThomsonTan commented Jul 11, 2023

Fixes #2172

Changes

Please provide a brief description of the changes here.

For significant contributions please make sure you have completed the following items:

  • CHANGELOG.md updated for non-trivial changes
  • Unit tests have been added
  • Changes in public API reviewed

@ThomsonTan ThomsonTan requested a review from a team July 11, 2023 20:55
@codecov
Copy link

codecov bot commented Jul 11, 2023

Codecov Report

Merging #2229 (8253dd4) into main (8f97cab) will increase coverage by 0.31%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2229      +/-   ##
==========================================
+ Coverage   87.32%   87.62%   +0.31%     
==========================================
  Files         169      198      +29     
  Lines        4897     5856     +959     
==========================================
+ Hits         4276     5131     +855     
- Misses        621      725     +104     
Files Changed Coverage Δ
api/include/opentelemetry/logs/event_id.h 83.34% <ø> (ø)
api/include/opentelemetry/logs/event_logger.h 92.31% <ø> (ø)
...include/opentelemetry/logs/event_logger_provider.h 100.00% <ø> (ø)
api/include/opentelemetry/logs/log_record.h 100.00% <ø> (ø)
api/include/opentelemetry/logs/logger.h 64.59% <ø> (ø)
api/include/opentelemetry/logs/logger_provider.h 100.00% <ø> (ø)
...pi/include/opentelemetry/logs/logger_type_traits.h 84.00% <ø> (ø)
api/include/opentelemetry/logs/noop.h 78.58% <ø> (ø)
api/include/opentelemetry/logs/provider.h 100.00% <ø> (ø)
exporters/ostream/src/log_record_exporter.cc 97.15% <ø> (ø)
... and 17 more

... and 9 files with indirect coverage changes

@lalitb lalitb requested a review from owent July 11, 2023 23:10
@marcalff
Copy link
Member

Per discussion in C++ SIG meeting (2023-07-12):

  • the spec-compliance-matrix should be updated (separate spec PR) to document the logs features supported in C++
  • the build should be cleaned in CI

before merging this PR.

@ThomsonTan ThomsonTan changed the title Prepare to mark logs signal as stable Mark logs signal as stable API/SDK Jul 27, 2023
Copy link
Member

@marcalff marcalff left a comment

Choose a reason for hiding this comment

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

Looks good overall.

See a comment on empty_attributes.h

sdk/include/opentelemetry/sdk/common/empty_attributes.h Outdated Show resolved Hide resolved
Copy link
Member

@owent owent left a comment

Choose a reason for hiding this comment

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

LGTM and thanks.

the current OpenTelemetry Log specification matures. The current
implementation can be included in build by setting `ENABLE_LOGS_PREVIEW`
preprocessor macro.
| Logs | Public Release | N/A |
Copy link
Member

@lalitb lalitb Aug 1, 2023

Choose a reason for hiding this comment

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

Any plans to update the compliance matrix before marking this stable?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, will update it.

#include "opentelemetry/sdk/logs/logger_provider.h"
#include "opentelemetry/sdk/logs/read_write_log_record.h"
#include "opentelemetry/sdk/logs/simple_log_record_processor.h"
#include "opentelemetry/sdk/version/version.h"
Copy link
Member

Choose a reason for hiding this comment

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

Some of the above headers have been added twice, Can you please check this once.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I didn't see any header file is included twice directly. Do you mean some header file in the list is also included indirectly?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we can fix this later if it is an issue.

@ThomsonTan ThomsonTan merged commit 8c82d24 into open-telemetry:main Aug 1, 2023
42 checks passed
@ThomsonTan ThomsonTan deleted the mark_logs_stable branch August 1, 2023 07:19
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.

[API] Announce stable logging API
4 participants