@salesforce/plugin-telemetry

v3.6.20

Command usage and error telemetry for the Salesforce CLI For more information about how to use this package see README

Latest version published 6 days ago

License: BSD-3-Clause

NPM

GitHub

Package Health Score

84 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
3.6.20	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.6.18	\|	10/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.5.1	\|	06/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.3.8	\|	10/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.4.0	\|	12/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

BSD-3-Clause

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (184,596)

GitHub Stars: 5
Forks: 1
Contributors: 20

Direct Usage Popularity

The npm package @salesforce/plugin-telemetry receives a total of 184,596 downloads a week. As such, we scored @salesforce/plugin-telemetry popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @salesforce/plugin-telemetry, we found that it has been starred 5 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 20
Funding: No

With more than 10 contributors for the @salesforce/plugin-telemetry repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 6 days ago
Last Commit: 22 hours ago

Further analysis of the maintenance status of @salesforce/plugin-telemetry based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @salesforce/plugin-telemetry demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=18.0.0

Age: 4 years
Dependencies: 7 Direct
Versions: 113
Install Size: 78.5 kB
Dist-tags: 3
# of Files: 35
Maintainers: 47
TS Typings: No

@salesforce/plugin-telemetry has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

plugin-telemetry

A plugin to record command usage and error telemetry for the Salesforce CLI.

This plugin is bundled with the CLI and will automatically collect usage data on all commands and plugins. To disable data collection, see this help document.

Note: This plugin should be included at a CLI level ONLY. No CLI plugins should include or depend on this plugin.

All command usage is recorded by initializing on the init oclif hook, recording all events to a log file, then spawning a process on exit to send the data to appinsights.

To debug the telemetry spawned process, run a command with the environment variables SF_TELEMETRY_DEBUG=true and DEBUG=sf:telemetry.

SF_TELEMETRY_DEBUG=true DEBUG=sf:telemetry* ./bin/dev telemetry

Getting Started

To build the plugin locally, make sure to have yarn installed and run the following commands:

# Clone the repository
git clone git@github.com:salesforcecli/plugin-telemetry

# Install the dependencies and compile
yarn install
yarn build

To use your plugin, run using the local ./bin/dev or ./bin/dev.cmd file.

# Run using local run file.
./bin/dev telemetry

There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.

# Link your plugin to the sfdx cli
sf plugins:link .
# To verify
sf plugins

@salesforce/plugin-telemetry dependencies

@oclif/core @salesforce/core @salesforce/kit @salesforce/sf-plugins-core @salesforce/telemetry @salesforce/ts-types debug

@salesforce/plugin-telemetry development dependencies

@oclif/plugin-command-snapshot @oclif/plugin-help @salesforce/cli-plugins-testkit @salesforce/dev-scripts @salesforce/plugin-command-reference @salesforce/ts-sinon @types/debug oclif ts-node typescript

FAQs

What is @salesforce/plugin-telemetry?

Command usage and error telemetry for the Salesforce CLI. Visit Snyk Advisor to see a full health score report for @salesforce/plugin-telemetry, including popularity, security, maintenance & community analysis.

Is @salesforce/plugin-telemetry popular?

The npm package @salesforce/plugin-telemetry receives a total of 184,596 weekly downloads. As such, @salesforce/plugin-telemetry popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @salesforce/plugin-telemetry well maintained?

We found that @salesforce/plugin-telemetry demonstrated a healthy version release cadence and project activity. It has a community of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @salesforce/plugin-telemetry safe to use?

The npm package @salesforce/plugin-telemetry was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 14 November-2024, at 08:42 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP