This commit is contained in:
Reiley Yang 2022-04-22 11:43:36 -07:00 коммит произвёл GitHub
Родитель f7ba38f9d3
Коммит cb544f186f
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
2 изменённых файлов: 13 добавлений и 41 удалений

Просмотреть файл

@ -4,12 +4,12 @@
If you find a bug, please file an issue in GitHub via the [issues](https://github.com/Microsoft/TraceLogging/issues) page.
# Contributing
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to
agree to a Contributor License Agreement (CLA) declaring that you have the right to,
and actually do, grant us the rights to use your contribution. For details, visit
https://cla.microsoft.com.
[https://cla.microsoft.com/](https://cla.microsoft.com/).
When you submit a pull request, a CLA-bot will automatically determine whether you need
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
@ -19,7 +19,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
# Release
## Release
This repository uses the [GitHub Flow](https://guides.github.com/introduction/flow/) model.
@ -37,4 +37,3 @@ Pull requests must use squash commit to keep master history clean.
Pull Requests must be approved by a member of the [Device Health Services Team](https://github.com/orgs/microsoft/teams/device-health-services-team).
Pull Requests must be up to date with master and must pass the CI status check.

Просмотреть файл

@ -1,7 +1,9 @@
# TraceLogging for LTTNG
# TraceLogging for LTTng
The TraceLogging for LTTNG project enables structured event emission through LTTNG via the same set of macros that are
supported by the publicly available [TraceLogging for ETW](https://docs.microsoft.com/windows/win32/tracelogging/trace-logging-about)
The TraceLogging for LTTng project enables structured event emission through
[LTTng](https://lttng.org/) via the same set of macros that are supported by the
publicly available [TraceLogging for
ETW](https://docs.microsoft.com/windows/win32/tracelogging/trace-logging-about)
in the Windows SDK.
## Examples
@ -35,7 +37,7 @@ TraceLoggingWrite(WidgetProvider,
TraceLoggingUnregister(WidgetProvider);
```
### Logging LTTNG events through TraceLogging API
### Logging LTTng events through TraceLogging API
In C++, TraceLoggingValue will attempt to deduce the logging type for you. There are specific per-type macro variants for C or for cases
where you wish to explicitly pick the logged type yourself. The TraceLogging header contains extensive comments on the type system.
@ -53,9 +55,9 @@ TraceLoggingWrite(
TraceLoggingValue(headers.c_str(), "ResponseHeaders"));
```
### Consuming LTTNG events logged through TraceLogging API
### Consuming LTTng events logged through TraceLogging API
To consume TraceLogging events sent through LTTNG, you will need the lttng-tools package (see [Dependencies](#Dependencies)). You can collect trace points using event wildcards:
To consume TraceLogging events sent through LTTng, you will need the lttng-tools package (see [Dependencies](#Dependencies)). You can collect trace points using event wildcards:
```bash
lttng create
@ -68,7 +70,7 @@ lttng stop
lttng view
```
For more information, see the [LTTNG Documentation](https://lttng.org/docs/v2.10/).
For more information, see the [LTTng Documentation](https://lttng.org/docs/v2.10/).
## Dependencies
@ -81,7 +83,7 @@ sudo apt update
sudo apt install liblttng-ust-dev
```
If your normal package repository uses an older version of LTTNG, consider using the ppa:lttng/stable-2.10 repository to get LTTNG 2.10:
If your normal package repository uses an older version of LTTng, consider using the ppa:lttng/stable-2.10 repository to get LTTng 2.10:
```bash
sudo apt-add-repository ppa:lttng/stable-2.10 -y
@ -103,32 +105,3 @@ TraceLogging builds as an interface library with a dependency on a static librar
1. Add this project as a subdirectory in your project, either as a git submodule or copying the code directly.
2. Add that directory to your top-level CMakeLists.txt with 'add_subdirectory'. This will make the target 'tracelogging' available.
3. Add the 'tracelogging' target to the target_link_libraries of any target that will use TraceLogging.
## Reporting Security Issues
Security issues and bugs should be reported privately, via email, to the
Microsoft Security Response Center (MSRC) at <[secure@microsoft.com](mailto:secure@microsoft.com)>.
You should receive a response within 24 hours. If for some reason you do not, please follow up via
email to ensure we received your original message. Further information, including the
[MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in the
[Security TechCenter](https://technet.microsoft.com/en-us/security/default).
## Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Contributing
Want to contribute? The team encourages community feedback and contributions. Please follow our [contributing guidelines](../CONTRIBUTING.md).
We also welcome [issues submitted on GitHub](https://github.com/Microsoft/TraceLogging/issues).
## Project Status
This project is currently in active development.
## Contact
The easiest way to contact us is via the [Issues](https://github.com/microsoft/TraceLogging/issues) page.