splunk/dashpub

Generate next.js apps to publish Splunk dashboards

Dashboard Publisher

EXPERIMENTAL tool that creates a Next.js project for a given list of Splunk dashboards, optionally making the dashboards accessible to anyone using Vercel. Search results are proxied through serverless functions, which handle authentication and efficient CDN caching.

Prerequisites

• Node.js 12+, NPM, Yarn
• Vercel CLI if you want to publish on Vercel

Get started

1. Install dashpub CLI globally

$ npm i -g @splunk/dashpub

2. Initialize a new project

$ dashpub init

Follow the instructions to create your dashboard project.

---

Copyright 2020 Splunk Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

dashpub's Issues

Error: ENOENT: no such file or directory, stat ‘/usr/lib/node_modules/@splunk/dashpub/yarn.lock’

Hey.

Just FYI, I ran into a bug:
When installing dashpub via npm, the yarn.lock file is missing locally. Copying the file from source to ‘/usr/lib/node_modules/@splunk/dashpub/ fixed the problem.
Then all works fine, great work, I really like it!

Cheers, Lukas

npm dependencies missing?

Hi, currently when installing this specific dependencies are not anymore available in the npm registry?

npm ERR! 404 Not Found - GET https://registry.npmjs.org/@splunk/visualization-editors/-/visualization-editors-18.2.1.tgz npm ERR! 404 npm ERR! 404 '@splunk/[email protected]' is not in the npm registry.

same with yarn
error An unexpected error occurred: "https://registry.yarnpkg.com/@splunk%2fvisualization-editors: Not found".

Instructions and dependencies for running the app on a kubernetes cluster

Hi,

We have tested dashpub from the oct23 branch (should it be merged to master?) on a classic Linux VM. Would it also be possible running it on a kubernetes cluster? We have a cluster available and can use argoCD to point to a app manifest. Would be great if someone can make instructions on this approach.

Thanks for a great project.

When running yarn dev, snaptshotted datasources don't load

For this, the fix would be to add something like this on line 30:

const agent = (process.env.SPLUNKD_URL || 'https://localhost').startsWith('https')


In the following file https://github.com/splunk/dashpub/blob/master/template/src/pages/api/data/%5Bdsid%5D.js

TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received undefined in oct-23 branch when doing dashpub update

Hi,

First of all, just to clarify what our goal is:
We want to set in package.json which app, title and app the dashpub app should load. This is a first step to containerizing it and set these parameters through environment variables.

When doing dashpub update in the oct-23 branch we see that the generateDashboards/generate function is broken.

We did the following:

1. Installed from branch oct-23.
2. Built a working dashboard using dashpub init. Tested with yarn dev.
3. Cloned project directory and edited package.json to change to a different dashboard.
4. dashpub update. Resulted in the following errors:

TypeError: generateDashboards is not a function
    at main (/home/user/node_modules/@splunk/dashpub/cli/cli.js:40:15)

5. We work around this by uncommenting this line:
   

   dashpub/cli/init.js

   Line 114 in b929e78

   //generateDashboards,

6. The next error is:

Generating undefined dashboards...
TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received undefined
    at validateString (node:internal/validators:162:11)
    at Object.join (node:path:1175:7)
    at generate (/home/user/node_modules/@splunk/dashpub/cli/builddash.js:93:23)
    at generateDashboards (/home/user/node_modules/@splunk/dashpub/cli/init.js:50:11)
    at main (/home/user/node_modules/@splunk/dashpub/cli/cli.js:40:15) {
  code: 'ERR_INVALID_ARG_TYPE'
}

7. Which is worked around by hardcoding the app name here:
   

   dashpub/cli/cli.js

   Line 40 in b929e78

   await generateDashboards(project.dashboards, splunkdInfo, process.cwd());

8. We changed this to the following, which resulted in dashpub update working again:

        await generateDashboards('ourappname', project.dashboards, splunkdInfo, process.cwd());

For timelapse, code looking for a macro does not look into the post process search

When using the timelapse feature in (not in the released version of dashpub), we need to ensure that we are looking for timelapse macros in the post-process search as well as the query. Currently macros in post-process are unsupported.

Empty Queries Causing Delays

When working in the source editor, if you define a query as "" it will run a very lengthy search. Example:

"annotation": { "type": "ds.search", "options": { "query": "" } },

Should probably filter out empty queries.