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

[Main][Task]27156360: Add json config cdn details to tool folder #2299

Merged
merged 6 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions tools/cfgsync-cdn/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Microsoft Application Insights JavaScript SDK - CfgSync Config Details

Define ThrottleMgrCfg Configurations and feature opt-in status details.

## Change History

### Version

1.0.0 (March, 2024)

| Name | Description | Details
|---------|------|----------------
| enabled | General on/off | `true` (on)
| featureOptIn | opt-in feature list | iKeyUsage (*inital opt-in*)
| featureOptIn.iKeyUsage.mode | feature-iKeyUsage enable/disable status | `3` (enable/opt-in)
| featureOptIn.iKeyUsage.onCfg | override values of the following cdn `config` when feature-iKeyUsage is enabled | <sub>DefaultThrottleMsgKey</sub></br>throttleMgrCfg.109.enabled: `false`</br> <sub>InstrumentationKeyDeprecation</sub></br> throttleMgrCfg.106.enabled: `true`
| featureOptIn.iKeyUsage.offCfg | override values of the following cdn `config` when feature-iKeyUsage is disabled | <sub>DefaultThrottleMsgKey</sub></br>throttleMgrCfg.109.enabled: `false`</br> <sub>InstrumentationKeyDeprecation</sub></br> throttleMgrCfg.106.enabled: `false`
| config | override values for user's core config | throttleMgrCfg
| config.throttleMgrCfg | override values for user's throttleMgrCfg under core config | <sub>InstrumentationKeyDeprecation</sub></br> throttleMgrCfg.106:</br>{ `"enabled": true`, *// will send ikey InstrumentationKey Deprecation message*</br>`"limit": { "samplingRate": 1, "maxSendNumber": 1}`, *// sampling rate: 0.0001%, and will send max one message per time* </br>`"interval": {"monthInterval": 6,"daysOfMonth": [1]}`} *// message will be sent on the first day every 6 month*,</br><sub>DefaultThrottleMsgKey</sub></br>throttleMgrCfg.109:</br>{ `"enabled": false`, *// will not send default ikey message*</br> ... *// all other settings are same with the InstrumentationKeyDeprecation settings*}</br>

Karlie-777 marked this conversation as resolved.
Show resolved Hide resolved
## Contributing
Karlie-777 marked this conversation as resolved.
Show resolved Hide resolved

Karlie-777 marked this conversation as resolved.
Show resolved Hide resolved
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.

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
instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

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.

## Data Collection

As this SDK is designed to enable applications to perform data collection which is sent to the Microsoft collection endpoints the following is required to identify our privacy statement.

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

## Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

## License

[MIT](LICENSE)
53 changes: 53 additions & 0 deletions tools/cfgsync-cdn/ai.cfgsync.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
{
"name": "Application Insights CfgSync CDN",
"description":"Application Insights throttleMgrCfg Configurations and feature opt-in Details",
"version": "1.0.0",
"homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
"author": "Microsoft Application Insights Team",
"sideEffects": false,
"repository": {
"type": "git",
"url": "https://github.com/microsoft/ApplicationInsights-JS"
Karlie-777 marked this conversation as resolved.
Show resolved Hide resolved
},
"enabled": true,
Karlie-777 marked this conversation as resolved.
Show resolved Hide resolved
"featureOptIn": {
"iKeyUsage": {
"mode": 3,
"onCfg": {
"throttleMgrCfg.109.enabled": false,
"throttleMgrCfg.106.enabled": true
},
"offCfg": {
"throttleMgrCfg.109.enabled": false,
"throttleMgrCfg.106.enabled": false
}
}
},
"config": {
"throttleMgrCfg": {
"109": {
"enabled": false,
"limit": {
"samplingRate": 1,
"maxSendNumber": 1
},
"interval": {
"monthInterval": 6,
"daysOfMonth": [1]
}
},
"106": {
"enabled": true,
"limit": {
"samplingRate": 1,
"maxSendNumber": 1
},
"interval": {
"monthInterval": 6,
"daysOfMonth": [1]
}
}
}
},
"license": "MIT"
}
Loading