@fluidframework/telemetry-utils
Common telemetry utilities used by Fluid Framework
Using Fluid Framework libraries
When taking a dependency on a Fluid Framework library, we recommend using a ^
(caret) version range, such as ^1.3.4
.
While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
library consumers should always prefer ^
.
Note that when depending on a library version of the form 2.0.0-internal.x.y.z
, called the Fluid internal version scheme,
you must use a >= <
dependency range (such as >=2.0.0-internal.x.y.z <2.0.0-internal.w.0.0
where w
is x+1
).
Standard ^
and ~
ranges will not work as expected.
See the @fluid-tools/version-tools
package for more information including tools to convert between version schemes.
Installation
To get started, install the package by running the following command:
npm i @fluidframework/telemetry-utils
API Documentation
API documentation for @fluidframework/telemetry-utils is available at https://fluidframework.com/docs/apis/telemetry-utils.
Contribution Guidelines
There are many ways to contribute to Fluid.
Detailed instructions for working in the repo can be found in the Wiki.
This project has adopted the Microsoft Open Source Code of Conduct.
For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
Use of these trademarks or logos must follow Microsoft’s Trademark & Brand Guidelines.
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Help
Not finding what you're looking for in this README? Check out our GitHub
Wiki or fluidframework.com.
Still not finding what you're looking for? Please file an
issue.
Thank you!
Trademark
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
Use of these trademarks or logos must follow Microsoft's Trademark & Brand Guidelines.
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.