From a219f3bdbff44f17e9a24a562770ec3b5952d54b Mon Sep 17 00:00:00 2001 From: moonrailgun Date: Thu, 4 Apr 2024 22:05:19 +0800 Subject: [PATCH] docs: add document about telemetry parameters --- website/docs/telemetry/params.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 website/docs/telemetry/params.md diff --git a/website/docs/telemetry/params.md b/website/docs/telemetry/params.md new file mode 100644 index 0000000..89bbbc3 --- /dev/null +++ b/website/docs/telemetry/params.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 2 +--- + +# Parameters + +Here is some example for how to use and config with telemetry image. + +All is optional. its will improve your usage in different place. + +| name | description | +| -------- | --------- | +| url | default will get referrer url which auto generate by browser, but in some website will dont allow carry this header, so you have to bring it by your self. if Tianji cannot get url in any where, system will ignore and not record this visit | +| name | define telemetry event name, its can be use for distinguish different event but in same telemetry record. | +| title | **[Badge ONLY]**, define badge title | +| start | **[Badge ONLY]**, define badge start count number | +| fullNum | **[Badge ONLY]**, define badge will show full number, default is abbreviated digits(for example: `12345` and `12.3k`) | + +## How to use + +Its easy to carry params on url + +for example: + +``` +https://tianji.example.com/telemetry///badge.svg?name=myEvent&url=https://google.com&title=My+Counter&start=100000&fullNum=true +``` + +If you dont familiar with this, you can check wiki page about this: [https://en.wikipedia.org/wiki/Query_string](https://en.wikipedia.org/wiki/Query_string)