vigil_reporter 1.2.0

Vigil Reporter for Dart. Used in pair with Vigil, the Microservices Status Page.

dart-vigil-reporter

Vigil Reporter for Dart. Used in pair with Vigil, the Microservices Status Page.

Vigil Reporter is used to actively submit health information to Vigil from your apps. Apps are best monitored via application probes, which are able to report detailed system information such as CPU and RAM load. This lets Vigil show if an application host system is under high load.

🇫🇷 Crafted in France, Nantes.

Who uses it?

Pikomit

👋 You use vigil_reporter and you want to be listed there? Email me.

How to install?

Include vigil_reporter in your pubspec.yaml dependencies.

dependencies:
  vigil_reporter: ^1.2.0

Alternatively, you can run dart pub add vigil-reporter.

How to use?

1. Create reporter

vigil_reporter can be instantiated as such:

import 'package:vigil_reporter/vigil_reporter.dart';

final vigilReporter = VigilReporter(
  url: 'https://status.example.com',
  token: 'YOUR_TOKEN_SECRET',
  probeId: 'relay',
  nodeId: 'socket-client',
  replicaId: '192.168.1.10',
  interval: 30,
  logger: VigilLogger(), // defaults to null (no logs)
);

2. Teardown reporter

If you need to teardown an active reporter, you can use the end(bool flush) method to unbind it.

vigilReporter.end(flush: false)
	.then(() {
		// Handle end there
	}).catchError(() {
		// Handle error there
	});

What is Vigil?

ℹ️ Wondering what Vigil is? Check out valeriansaliou/vigil.