Kamon icon indicating copy to clipboard operation
Kamon copied to clipboard

Documentation on how to use the library

Open kirach opened this issue 6 years ago • 2 comments

Hi, thanks for the great work!

I'm looking for any documentation/examples of how to connect kamon to play framework application and I can't find any. I've added all the dependencies and configured the app to use AspectJ weaver but the questions are:

  • Should I add any config options to my app's application.conf to start using kamon?
  • Do I have to explicitly call Kamon.loadModules() when starting the app or the library will take care of that?
  • Do I have to explicitly add reporters if I want to send all metrics to prometheus/zipkin like it's stated in readme?
Kamon.addReporter(new PrometheusReporter())
Kamon.addReporter(new ZipkinReporter())

Sorry if there is information about this somewhere on the webiste but I couldn't find it. Also the link on the top of this repo https://kamon.io/integrations/web-and-http-toolkits/play is broken. I will be happy to make a PR and update the README if you can answer my questions.

kirach avatar Apr 03 '19 15:04 kirach

  1. You shouldn't add explicitly any configuration for play-module.
  2. You can add reporters explicitlly(for better control) or via configuration kamon.reporters

yarosman avatar Apr 25 '19 13:04 yarosman

I agree that there should be some examples on how to plugin a specific reporter.

Reeebuuk avatar May 14 '19 19:05 Reeebuuk