Dashboards & Visualizations

How to add meaningful descriptions to charts.

ericrobinson
Path Finder

How do I add a few lines of text in a graph explaining what they are seeing on the graph? We have several searches showing transactions across many services that could use an explanation. A good description would be helpful.

Tags (1)

sideview
SplunkTrust
SplunkTrust

If you're in the Simplified XML, I believe you can just use an <html>foo</html> node but I dont use simplified XML and where exactly that node is allowed to live in the XML might take a little experimentation.

If you're using the advanced XML,

1) you can use the SimpleResultsHeader module like hazedev recommended. You dont have to have the count or the timerange in it - in fact it's frequently omitted. But if you want to, you can include the count by having $count$ somewhere in the string, and you can similarly include the timerange with $time$.

2) You can let the FlashChart module handle it. If FlashChart is given a context key called charting.chartTitle, it will display a little black header right above the Flash bits. You can set this key from HiddenChartFormatter by adding the additional param

<param name="charting.chartTitle">distinct users over time</param>

3) There is also the StaticContentSample module. It's sort of a vestigial prototype module, but it does offer the very simple ability to output a string to the screen with it's text param.

4) Then there's the ServerSideInclude module, which will display an HTML file that you packaged over in etc/apps/<appname>/appserver/static/yourHTMLFile.html. Which is kind of overkill usually but comes in handy when you want to repeat the same exact static text in multiple places.

5) If you're using the sideview_utils app, there's an HTML module that would do a good job. you give it a single parameter called html, which you probably want to wrap in CDATA. It can display the counts and the times, and any upstream UI variables, any variables from the querystring, and it can even include fields from search results. sideview_utils app has more documentation on this.

0 Karma

hazekamp
Builder

If you are using advanced XML check out SimpleResultsHeader module.

"This module displays a header like '23,420 events' and is for placement generally above a FlashTimeline or above a set of modules implementing paging controls"

hazekamp
Builder

As Nick eluded to below you could use static HTML or SRH w/o the fancy stuff.

0 Karma

ericrobinson
Path Finder

I think I am looking for something much simpler I think.. Just text inline with the graph talking about the data.

0 Karma
Get Updates on the Splunk Community!

Extending Observability Content to Splunk Cloud

Watch Now!   In this Extending Observability Content to Splunk Cloud Tech Talk, you'll see how to leverage ...

More Control Over Your Monitoring Costs with Archived Metrics!

What if there was a way you could keep all the metrics data you need while saving on storage costs?This is now ...

New in Observability Cloud - Explicit Bucket Histograms

Splunk introduces native support for histograms as a metric data type within Observability Cloud with Explicit ...