telemetry_sh

Description:

telemetry sh

Telemetry Sh #



A simple telemetry logging SDK for Dart
Installation 💻 #
❗ In order to start using Telemetry Sh you must have the Dart SDK installed on your machine.
Install via dart pub add:
dart pub add telemetry_sh
copied to clipboard

Features #

Log data to specific tables.
Query telemetry data using SQL queries.
Simple and easy-to-use interface.
Supports additional parameters for customization.


Usage 🚀 #
1. Import the package
import 'package:telemetry_sh/telemetry_sh.dart';
copied to clipboard
2. Initialize the Telemetry Sh instance
final telemetry = TelemetrySh('YOUR_API_KEY');
copied to clipboard
3. Log data to a table
await telemetry.log('table_name', {'key': 'value'});
copied to clipboard
4. Query telemetry data
final data = await telemetry.query('SELECT * FROM table_name');
copied to clipboard

Continuous Integration 🤖 #
Telemetry Sh comes with a built-in GitHub Actions workflow powered by Very Good Workflows but you can also add your preferred CI/CD solution.
Out of the box, on each pull request and push, the CI formats, lints, and tests the code. This ensures the code remains consistent and behaves correctly as you add functionality or make changes. The project uses Very Good Analysis for a strict set of analysis options used by our team. Code coverage is enforced using the Very Good Workflows.

Running Tests 🧪 #
To run all unit tests:
dart pub global activate coverage 1.2.0
dart test --coverage=coverage
dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info
copied to clipboard
To view the generated coverage report you can use lcov.
# Generate Coverage Report
genhtml coverage/lcov.info -o coverage/

# Open Coverage Report
open coverage/index.html
copied to clipboard