-
Notifications
You must be signed in to change notification settings - Fork 1k
Logs SDK #3549
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
Merged
Merged
Logs SDK #3549
Changes from 1 commit
Commits
Show all changes
50 commits
Select commit
Hold shift + click to select a range
0a00912
feat(sdk-logs): sdk-logs init
fuaiyi 0a8910d
feat(sdk-logs): sdk-logs init
fuaiyi f25e7cf
feat(sdk-logs): sdk-logs init
fuaiyi b50422e
feat(sdk-logs): sdk-logs init
fuaiyi 5fb3f64
feat(sdk-logs): sdk-logs init
fuaiyi 76e66c1
feat(sdk-logs): sdk-logs init
fuaiyi 2214a51
feat(sdk-logs): sdk-logs init
fuaiyi b5a51b4
fix compile errors
martinkuba f1f34a8
Merge remote-tracking branch 'upstream/main' into logs-sdk
fuaiyi 8f8d25e
feat(sdk-logs): sdk-logs init
fuaiyi 999f971
feat(sdk-logs): sdk-logs init
fuaiyi 097d15d
feat(sdk-logs): sdk-logs init
fuaiyi 1e1263b
feat(sdk-logs): sdk-logs init
fuaiyi 66090b0
feat(sdk-logs): sdk-logs init
fuaiyi f045cf6
feat(sdk-logs): sdk-logs init
fuaiyi 8196379
feat(sdk-logs): sdk-logs init
fuaiyi af2ae70
feat(sdk-logs): sdk-logs init
fuaiyi 4a54b6f
Merge remote-tracking branch 'upstream/main' into logs-sdk
fuaiyi 681d937
feat(sdk-logs): sdk-logs init
fuaiyi b06e7f3
feat(sdk-logs): sdk-logs init
fuaiyi 6448b43
feat(sdk-logs): sdk-logs init
fuaiyi 03ff511
feat(sdk-logs): add browser test config
fuaiyi a29f149
feat: add test-utils compatible assert.rejects
fuaiyi 7803d66
feat(sdk-logs): fix writing errors in README
fuaiyi 1a9a89e
Merge remote-tracking branch 'upstream/main' into logs-sdk
fuaiyi bb051ee
feat(sdk-logs): update version to 0.36.1
fuaiyi 8bcb18d
feat(sdk-logs): add examples
fuaiyi 413025f
feat(sdk-logs): fix LogRecord default timestamp to Date.now()
fuaiyi 314ff95
feat(sdk-logs): logRecord support rewrite time/body/severityNumber/ne…
fuaiyi 8d476d2
feat(sdk-logs): add logs processor environments
fuaiyi e579b13
feat(sdk-logs): modify export style
fuaiyi ab3b861
feat(sdk-logs): update version to 0.36.1
fuaiyi 2501941
feat(sdk-logs): remove exporter factory
fuaiyi c0c1320
feat(sdk-logs): update CHANGELOG
fuaiyi 14b1a55
feat(sdk-logs): change the processing of schemeUrl
fuaiyi e8ced53
feat(sdk-logs): split LoggerProviderConfig and LoggerConfig
fuaiyi 8363356
feat(sdk-logs): getLogger with default name when name is invalid
fuaiyi b7e399e
feat(sdk-logs): improve the shutdown logic of LoggerProvider
fuaiyi b43efff
feat(sdk-logs): improve the shutdown logic of LoggerProvider
fuaiyi 74fc360
Merge remote-tracking branch 'upstream/main' into logs-sdk
fuaiyi f423693
feat(sdk-logs): make log record read-only after it has been emitted
fuaiyi 4cca19f
feat(sdk-logs): logger option support includeTraceContext & LogRecord…
fuaiyi 4cb0337
feat(sdk-logs): update version
fuaiyi dcc1c6a
feat(sdk-logs): update version
fuaiyi 0c3e7b3
feat(sdk-logs): update logs example with typescript
fuaiyi 6d0cc64
feat(sdk-logs): update peerDependencies
fuaiyi e01b734
feat(sdk-logs): peer-api-check support @opentelemetry/api-logs
fuaiyi d8d8a95
feat(sdk-logs): update peerDependencies
fuaiyi fc2e666
Merge branch 'main' into logs-sdk
dyladan 0c1c95a
Merge branch 'main' into logs-sdk
dyladan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next
Next commit
feat(sdk-logs): sdk-logs init
- Loading branch information
commit 0a00912a1fc53ec97ab5a6f3a29b23c6dc157608
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| build |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| module.exports = { | ||
| env: { | ||
| mocha: true, | ||
| node: true, | ||
| }, | ||
| ...require("../../../eslint.config.js"), | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| /bin | ||
| /coverage | ||
| /doc | ||
| /test |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,201 @@ | ||
| Apache License | ||
| Version 2.0, January 2004 | ||
| http://www.apache.org/licenses/ | ||
|
|
||
| TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
|
||
| 1. Definitions. | ||
|
|
||
| "License" shall mean the terms and conditions for use, reproduction, | ||
| and distribution as defined by Sections 1 through 9 of this document. | ||
|
|
||
| "Licensor" shall mean the copyright owner or entity authorized by | ||
| the copyright owner that is granting the License. | ||
|
|
||
| "Legal Entity" shall mean the union of the acting entity and all | ||
| other entities that control, are controlled by, or are under common | ||
| control with that entity. For the purposes of this definition, | ||
| "control" means (i) the power, direct or indirect, to cause the | ||
| direction or management of such entity, whether by contract or | ||
| otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
| outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
|
||
| "You" (or "Your") shall mean an individual or Legal Entity | ||
| exercising permissions granted by this License. | ||
|
|
||
| "Source" form shall mean the preferred form for making modifications, | ||
| including but not limited to software source code, documentation | ||
| source, and configuration files. | ||
|
|
||
| "Object" form shall mean any form resulting from mechanical | ||
| transformation or translation of a Source form, including but | ||
| not limited to compiled object code, generated documentation, | ||
| and conversions to other media types. | ||
|
|
||
| "Work" shall mean the work of authorship, whether in Source or | ||
| Object form, made available under the License, as indicated by a | ||
| copyright notice that is included in or attached to the work | ||
| (an example is provided in the Appendix below). | ||
|
|
||
| "Derivative Works" shall mean any work, whether in Source or Object | ||
| form, that is based on (or derived from) the Work and for which the | ||
| editorial revisions, annotations, elaborations, or other modifications | ||
| represent, as a whole, an original work of authorship. For the purposes | ||
| of this License, Derivative Works shall not include works that remain | ||
| separable from, or merely link (or bind by name) to the interfaces of, | ||
| the Work and Derivative Works thereof. | ||
|
|
||
| "Contribution" shall mean any work of authorship, including | ||
| the original version of the Work and any modifications or additions | ||
| to that Work or Derivative Works thereof, that is intentionally | ||
| submitted to Licensor for inclusion in the Work by the copyright owner | ||
| or by an individual or Legal Entity authorized to submit on behalf of | ||
| the copyright owner. For the purposes of this definition, "submitted" | ||
| means any form of electronic, verbal, or written communication sent | ||
| to the Licensor or its representatives, including but not limited to | ||
| communication on electronic mailing lists, source code control systems, | ||
| and issue tracking systems that are managed by, or on behalf of, the | ||
| Licensor for the purpose of discussing and improving the Work, but | ||
| excluding communication that is conspicuously marked or otherwise | ||
| designated in writing by the copyright owner as "Not a Contribution." | ||
|
|
||
| "Contributor" shall mean Licensor and any individual or Legal Entity | ||
| on behalf of whom a Contribution has been received by Licensor and | ||
| subsequently incorporated within the Work. | ||
|
|
||
| 2. Grant of Copyright License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| copyright license to reproduce, prepare Derivative Works of, | ||
| publicly display, publicly perform, sublicense, and distribute the | ||
| Work and such Derivative Works in Source or Object form. | ||
|
|
||
| 3. Grant of Patent License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| (except as stated in this section) patent license to make, have made, | ||
| use, offer to sell, sell, import, and otherwise transfer the Work, | ||
| where such license applies only to those patent claims licensable | ||
| by such Contributor that are necessarily infringed by their | ||
| Contribution(s) alone or by combination of their Contribution(s) | ||
| with the Work to which such Contribution(s) was submitted. If You | ||
| institute patent litigation against any entity (including a | ||
| cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
| or a Contribution incorporated within the Work constitutes direct | ||
| or contributory patent infringement, then any patent licenses | ||
| granted to You under this License for that Work shall terminate | ||
| as of the date such litigation is filed. | ||
|
|
||
| 4. Redistribution. You may reproduce and distribute copies of the | ||
| Work or Derivative Works thereof in any medium, with or without | ||
| modifications, and in Source or Object form, provided that You | ||
| meet the following conditions: | ||
|
|
||
| (a) You must give any other recipients of the Work or | ||
| Derivative Works a copy of this License; and | ||
|
|
||
| (b) You must cause any modified files to carry prominent notices | ||
| stating that You changed the files; and | ||
|
|
||
| (c) You must retain, in the Source form of any Derivative Works | ||
| that You distribute, all copyright, patent, trademark, and | ||
| attribution notices from the Source form of the Work, | ||
| excluding those notices that do not pertain to any part of | ||
| the Derivative Works; and | ||
|
|
||
| (d) If the Work includes a "NOTICE" text file as part of its | ||
| distribution, then any Derivative Works that You distribute must | ||
| include a readable copy of the attribution notices contained | ||
| within such NOTICE file, excluding those notices that do not | ||
| pertain to any part of the Derivative Works, in at least one | ||
| of the following places: within a NOTICE text file distributed | ||
| as part of the Derivative Works; within the Source form or | ||
| documentation, if provided along with the Derivative Works; or, | ||
| within a display generated by the Derivative Works, if and | ||
| wherever such third-party notices normally appear. The contents | ||
| of the NOTICE file are for informational purposes only and | ||
| do not modify the License. You may add Your own attribution | ||
| notices within Derivative Works that You distribute, alongside | ||
| or as an addendum to the NOTICE text from the Work, provided | ||
| that such additional attribution notices cannot be construed | ||
| as modifying the License. | ||
|
|
||
| You may add Your own copyright statement to Your modifications and | ||
| may provide additional or different license terms and conditions | ||
| for use, reproduction, or distribution of Your modifications, or | ||
| for any such Derivative Works as a whole, provided Your use, | ||
| reproduction, and distribution of the Work otherwise complies with | ||
| the conditions stated in this License. | ||
|
|
||
| 5. Submission of Contributions. Unless You explicitly state otherwise, | ||
| any Contribution intentionally submitted for inclusion in the Work | ||
| by You to the Licensor shall be under the terms and conditions of | ||
| this License, without any additional terms or conditions. | ||
| Notwithstanding the above, nothing herein shall supersede or modify | ||
| the terms of any separate license agreement you may have executed | ||
| with Licensor regarding such Contributions. | ||
|
|
||
| 6. Trademarks. This License does not grant permission to use the trade | ||
| names, trademarks, service marks, or product names of the Licensor, | ||
| except as required for reasonable and customary use in describing the | ||
| origin of the Work and reproducing the content of the NOTICE file. | ||
|
|
||
| 7. Disclaimer of Warranty. Unless required by applicable law or | ||
| agreed to in writing, Licensor provides the Work (and each | ||
| Contributor provides its Contributions) on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
| implied, including, without limitation, any warranties or conditions | ||
| of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
| PARTICULAR PURPOSE. You are solely responsible for determining the | ||
| appropriateness of using or redistributing the Work and assume any | ||
| risks associated with Your exercise of permissions under this License. | ||
|
|
||
| 8. Limitation of Liability. In no event and under no legal theory, | ||
| whether in tort (including negligence), contract, or otherwise, | ||
| unless required by applicable law (such as deliberate and grossly | ||
| negligent acts) or agreed to in writing, shall any Contributor be | ||
| liable to You for damages, including any direct, indirect, special, | ||
| incidental, or consequential damages of any character arising as a | ||
| result of this License or out of the use or inability to use the | ||
| Work (including but not limited to damages for loss of goodwill, | ||
| work stoppage, computer failure or malfunction, or any and all | ||
| other commercial damages or losses), even if such Contributor | ||
| has been advised of the possibility of such damages. | ||
|
|
||
| 9. Accepting Warranty or Additional Liability. While redistributing | ||
| the Work or Derivative Works thereof, You may choose to offer, | ||
| and charge a fee for, acceptance of support, warranty, indemnity, | ||
| or other liability obligations and/or rights consistent with this | ||
| License. However, in accepting such obligations, You may act only | ||
| on Your own behalf and on Your sole responsibility, not on behalf | ||
| of any other Contributor, and only if You agree to indemnify, | ||
| defend, and hold each Contributor harmless for any liability | ||
| incurred by, or claims asserted against, such Contributor by reason | ||
| of your accepting any such warranty or additional liability. | ||
|
|
||
| END OF TERMS AND CONDITIONS | ||
|
|
||
| APPENDIX: How to apply the Apache License to your work. | ||
|
|
||
| To apply the Apache License to your work, attach the following | ||
| boilerplate notice, with the fields enclosed by brackets "[]" | ||
| replaced with your own identifying information. (Don't include | ||
| the brackets!) The text should be enclosed in the appropriate | ||
| comment syntax for the file format. We also recommend that a | ||
| file or class name and description of purpose be included on the | ||
| same "printed page" as the copyright notice for easier | ||
| identification within third-party archives. | ||
|
|
||
| Copyright [yyyy] [name of copyright owner] | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| # OpenTelemetry Logs SDK | ||
|
|
||
| [![NPM Published Version][npm-img]][npm-url] | ||
| [![Apache License][license-image]][license-image] | ||
|
|
||
| **Note: This is an experimental package under active development. New releases may include breaking changes.** | ||
|
|
||
| OpenTelemetry logs module contains the foundation for all logs SDKs of [opentelemetry-js](https://github.com/open-telemetry/opentelemetry-js). | ||
|
|
||
| Used standalone, this module provides methods for manual instrumentation of code, offering full control over recording logs for client-side JavaScript (browser) and Node.js. | ||
|
|
||
| It does **not** provide automated instrumentation of known libraries or host environment logs out-of-the-box. | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| npm install --save @opentelemetry/api-logs | ||
| npm install --save @opentelemetry/sdk-logs | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| The basic setup of the SDK can be seen as followings: | ||
|
|
||
| ```js | ||
| const logsAPI = require("@opentelemetry/api-logs"); | ||
| const { | ||
| LoggerProvider, | ||
| SimpleLogRecordProcessor, | ||
| ConsoleLogRecordExporter, | ||
| } = require("@opentelemetry/sdk-logs"); | ||
|
|
||
| // To start a logger, you first need to initialize the Logger provider. | ||
| const loggerProvider = new LoggerProvider(); | ||
| // Add a processor to export log record | ||
| loggerProvider.addLogRecordProcessor( | ||
| new SimpleLogRecordProcessor(new ConsoleLogRecordExporter()) | ||
| ); | ||
|
|
||
| // To create a log record, you first need to get a Logger instance | ||
| const logger = loggerProvider.getLogger("default"); | ||
|
|
||
| // You can also use global singleton | ||
| logsAPI.logs.setGlobalLoggerProvider(loggerProvider); | ||
| const logger = logsAPI.logs.getLogger("default"); | ||
|
|
||
| // logging an event in an instrumentation library | ||
| logger | ||
| .getLogEvent("event-name", { | ||
| severityNumber: SeverityNumber.WARN, | ||
| severityText: "WARN", | ||
| body: "this is a log event body", | ||
| attributes: { "log.type": "LogEvent" }, | ||
| }) | ||
| .emit(); | ||
|
|
||
| // logging an event in a log appender | ||
| logger | ||
| .getLogRecord({ | ||
| severityNumber: SeverityNumber.INFO, | ||
| severityText: "INFO", | ||
| body: "this is a log record body", | ||
| attributes: { "log.type": "LogRecord" }, | ||
| }) | ||
| .emit(); | ||
| ``` | ||
|
|
||
| ## Config | ||
|
|
||
| Logs configuration is a merge of user supplied configuration with both the default | ||
| configuration as specified in [config.ts](./src/config.ts) | ||
|
|
||
| ## Example | ||
|
|
||
| See [examples/logs](https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/examples/logs) | ||
fuaiyi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Useful links | ||
|
|
||
| - For more information on OpenTelemetry, visit: <https://opentelemetry.io/> | ||
| - For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js> | ||
| - For help or feedback on this project, join us in [GitHub Discussions][discussions-url] | ||
|
|
||
| ## License | ||
|
|
||
| Apache 2.0 - See [LICENSE][license-url] for more information. | ||
|
|
||
| [discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions | ||
| [license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/LICENSE | ||
| [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat | ||
| [npm-url]: https://www.npmjs.com/package/@opentelemetry/sdk-logs | ||
| [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fmetrics.svg | ||
fuaiyi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| /*! | ||
| * Copyright The OpenTelemetry Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| const karmaWebpackConfig = require("../../../karma.webpack"); | ||
| const karmaBaseConfig = require("../../../karma.base"); | ||
|
|
||
| module.exports = (config) => { | ||
| config.set( | ||
| Object.assign({}, karmaBaseConfig, { | ||
| webpack: karmaWebpackConfig, | ||
| }) | ||
| ); | ||
| }; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.