Sampling Example (#78)

braxtonj · web-flow · commit 46aa7c644ad3 · 2021-12-17T22:32:49.000-07:00
added sampling usage example to repo
diff --git a/README.md b/README.md
@@ -258,6 +258,22 @@ List of fields out of `record` object to include in the `meta` object. By defaul
 
 Instance of a "sampling class". Used to decide if a log should be sent via a random selection over some distribution.  The default sends everything.  However, the `UniformSampling` class is included and extension of `Sampling` is welcome.
 
+Example usage to send 75% of your logs
+```python
+import logging
+from logdna import LogDNAHandler, UniformSampling
+
+log.getLogger('logdna_sample')
+
+uniform_sampler = UniformSampling(send_ratio=.75)
+options = {'hostname':'py_sample_test', 'sampling_instance':uniform_sampler}
+
+logdna_handler = LogDNAHandler("API_KEY",options)
+log.addHandler(logdna_handler)
+
+log.info("Maybe I'll send, maybe I won't.")
+```
+
 ### log(line, [options])
 
 #### line
diff --git a/logdna/__init__.py b/logdna/__init__.py
@@ -1,4 +1,5 @@
 from .logdna import LogDNAHandler
+from .sampling import Sampling, UniformSampling
 __all__ = ['LogDNAHandler']
 
 # Publish this class to the "logging.handlers" module so that it can be use

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`from .logdna import LogDNAHandler`
	`2`	`+from .sampling import Sampling, UniformSampling`
`2`	`3`	`__all__ = ['LogDNAHandler']`
`3`	`4`
`4`	`5`	`# Publish this class to the "logging.handlers" module so that it can be use`