Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update plugin description and provisioned dashboard #7803

Merged
merged 2 commits into from
Feb 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion sdk/highlightinc-highlight-datasource/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,12 @@ The query editor is configurable with these fields:
|`Group by`|One or more categories to group the results by. Categorical fields from the linked project's data are shown as search suggestions.|
|`Limit N`|If one or more "group by" categories are selected, the result groups are limited to the top N.|
|`Limit by function`|If one or more "group by" categories are selected, this method is used to rank categories before returning the top N.|
|`Bucket by`|The dimension used for bucketing data. Supports bucketing by timestamp or no bucketing.|
|`Bucket by`|The dimension used for bucketing numeric data. Supports bucketing by timestamp, no bucketing, or a custom bucketing key for histogram visualizations.|
|`Buckets`|The number of buckets returned.|

## Documentation
The docs page for the highlight.io Grafana plugin is available [here](https://www.highlight.io/docs/general/integrations/grafana-integration/overview).

If you have any further questions about highlight.io, you can visit our [docs](https://www.highlight.io/docs) or reach out to us at [support@highlight.io](mailto:support@highlight.io).

## Contributing
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@
"targets": [
{
"bucketBy": "Timestamp",
"bucketCount": 50,
"column": "duration",
"datasource": {
"type": "highlightinc-highlight-datasource",
Expand Down Expand Up @@ -198,6 +199,7 @@
"targets": [
{
"bucketBy": "Timestamp",
"bucketCount": 50,
"column": "duration",
"datasource": {
"type": "highlightinc-highlight-datasource",
Expand All @@ -208,7 +210,7 @@
"limitAggregator": "Avg",
"limitColumn": "duration",
"metric": "Avg",
"queryText": "service_name:-\"\"",
"queryText": "service_name EXISTS",
"refId": "A",
"table": "traces"
}
Expand Down Expand Up @@ -265,6 +267,7 @@
"targets": [
{
"bucketBy": "Timestamp",
"bucketCount": 50,
"column": "numPages",
"datasource": {
"type": "highlightinc-highlight-datasource",
Expand Down Expand Up @@ -332,6 +335,7 @@
"targets": [
{
"bucketBy": "None",
"bucketCount": 1,
"column": "clickTextContent",
"datasource": {
"type": "highlightinc-highlight-datasource",
Expand All @@ -342,7 +346,7 @@
"limitAggregator": "Count",
"limitColumn": "duration",
"metric": "Count",
"queryText": "country:\"United States\" country:\"Canada\"",
"queryText": "country:\"United States\" OR country:\"Canada\"",
"refId": "A",
"table": "sessions"
}
Expand Down
6 changes: 5 additions & 1 deletion sdk/highlightinc-highlight-datasource/src/plugin.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"alerting": true,
"metrics": true,
"info": {
"description": "highlight.io is a monitoring tool for the next generation of developers (like you!). Unlike the age-old, outdated tools out there, we aim to build a cohesive, modern and fully-featured monitoring solution, something we wished WE had. And it's all open source :)",
"description": "Query and alert based on metrics from highlight.io traces, logs, errors, and sessions.",
"author": {
"name": "Highlight.io"
},
Expand All @@ -21,6 +21,10 @@
{
"name": "Home",
"url": "https://www.highlight.io/"
},
{
"name": "Project",
"url": "https://github.com/highlight/highlight"
}
],
"screenshots": [
Expand Down
Loading