| If you find that your copied panel is blank, take a look at resolving that in this article: [Fixing Blank Copied Panel](https://kb.filewave.com/books/dashboard-grafana/page/221-copied-panel-is-blank "2.2.1 Copied Panel is Blank") |
| The Query |
|  |
| The query defines the data available to the panel. This example uses an inventory query. |
| The Visualization |
|  |
| An inventory query returns table-shaped data, so this example uses a table visualization. Other data sources can support gauges, charts, and graphs. |
| General |
|  |
| This example sets only the panel name. You can also add a link that opens the related FileWave report, giving dashboard users a direct path to the underlying device data. |
| Step | Example |
| 1. Place a new (or copied) yml file into /usr/local/etc/filewave/prometheus/conf.d/jobs/https with a meaningful name. |  |
| 2. Edit the new file to specify the following 3 things: \* The inventory query (report) to use \* The field you want to count by...device\_id is almost always a good one if reporting by device \* The field you want summarize (aggregate) by...in this case, the filewave client version | |
| 3. Once your report is created, the report id to use is most easily accessed through the webadmin. Note that the fields you want to use for aggregation must be in the report. |  |
| 4. Get the definition for the fields you want to use from the API...the easiest way is to do a curl from the command line like this:
`bash curl -s -k -H "Authorization: ` Make sure and substitute in your values for the <Base64\_API\_Token>, <my.server.address> and <report\_id> You'll get a response that includes the component and the field names as shown at right |  |
| 4. Edit the YML file to specify the 3 items as they match your report definition, then save the file. If using the sample file, remember to take out the comment # at the beginning of each line. Example at right: |  |
| ssh -L 8000:localhost:21090 user@my.server.address |
| /usr/local/etc/filewave/grafana/conf/filewave.ini |
| sudo fwcontrol server restart |
Alerts are available only for visualizations of type **Graph**.
## When/Why Use an existing custom dashboard graph as the data source for an alert. ## How Open the graph's drop-down menu and select **Edit**:  Select the Notification icon and configure the alert condition. In this example, the alert triggers when the total device count exceeds 20.  Add a message that tells recipients what crossed the threshold and what they should check next. # 5.0 Grafana Plugins # Plugin Installation Grafana plugins can add panels, data sources, and visualizations to the FileWave Dashboard.Install signed plugins only. Plugins found through Grafana's built-in search should already be approved, but plugins can also come from other sources.
## Installation Search for plugins in the Grafana Dashboard under the configuration area. [](https://kb.filewave.com/uploads/images/gallery/2023-08/71w5kmCEWtTj0ZXd-image.png) On selecting a plugin though, at the bottom of the description it will indicate necessary permissions are not enabled: [](https://kb.filewave.com/uploads/images/gallery/2023-08/UIXgou3xmbXe4ul3-image.png) Installing plugins through the Grafana GUI requires Grafana Admin access. FileWave does not allow plugin installation through that path, so install plugins from the command line directly on the server. ### Command Line Installation The plugin page includes a command-line installation section. Do not copy that command as-is for FileWave, but use it to identify the plugin name required by the FileWave server command. Taking Apache ECharts as an example: [](https://kb.filewave.com/uploads/images/gallery/2023-08/I0AYJ9VBWlTMXnre-image.png) From the description, the plugin name is: `volkovlabs-echarts-panel` The command to install this plugin on a FileWave Server would be: ``` /usr/local/sbin/grafana-cli --pluginsDir=/usr/local/filewave/instrumentation_data/grafana/plugins --homepath=/usr/local/filewave/grafana plugins install volkovlabs-echarts-panel ``` The process should report success and the plugin should now be available. # Plugin Configuration Some plugins may require additional configuration, e.g. they require reference to additional files. An example of this is the CSV plugin by Marcus Olsson. When selecting the CSV Plugin as a Data Source, the path to the CSV file is required, with a choice of HTTP or Local: [](https://kb.filewave.com/uploads/images/gallery/2023-08/zx2PAZPvFbkbxN4T-image.png) ## Local Data Source By default, local data sources are not allowed. It is possible to overcome this via the Grafana 'ini' file, however this has limitations. The FileWave Grafana 'ini' file is defined as: `/usr/local/etc/filewave/grafana/conf/filewave.ini` Enablement of Local files is achieved by adding the following into this file: ``` [plugin.marcusolsson-csv-datasource] allow_local_mode = true ``` After doing so, the server service should be restarted: ``` fwcontrol server restart ``` Local files may now be accessed with this plugin. However, the caveat is that this file is overwritten by the FileWave installer on each upgrade. The outcome is the file must therefore be edited on each upgrade attempt. ### HTTP Data Source HTTP Data Source has no similar caveat. If there is already an available HTTP share in-house, this could be utilised. However, the FileWave Server could have the apache configuration adapted to include such files. #### Configure Apache This process will rely on Apache having access to a directory which serves these files. This could either be one that already exists or configuration could be used to add a new directory to serve just the required files.Recommendation would be to create a new directory.
This is editing FileWave Server files and folders. FileWave upgrades can overwrite files, folders or expansion of product may include new files and folders. Consider using a directory that is unlikely to clash with future updates.
In this example, the new chosen folder is: `/usr/local/filewave/grafana_plugins_custom/csv` 'grafana\_plugins\_custom' does not yet exist. Rather than just creating one custom plugin folder for all possible plugin use, in this example a subdirectory for the CSV files has been created. Additional plugins that also required http file shares could use the same parent, but have their own subfolder. The Apache file that can be edited to create new http file shares is: `/usr/local/filewave/apache/conf/httpd_custom.conf` As a FileWave Custom file, this will persist with Filewave upgrades. ``` Alias /plugins_custom /usr/local/filewave/grafana_plugins_custom/csvOther options should be configured as required.
FileWave Server process should be restarted once configured: ``` fwcontrol server restart ``` #### Downloading CSV files Once configured, CSV files may be populated into the newly created document. For example: ``` # ls -l /usr/local/filewave/grafana_plugins_custom/csv total 184 -rw-r--r-- 1 root _www 14425 Aug 3 17:06 admin.csv -rw-r--r-- 1 root _www 19364 Aug 3 17:06 data.csv -rw-r--r-- 1 root _www 36694 Aug 3 17:06 paint.csv -rw-r--r-- 1 root _www 19345 Aug 3 17:06 video.csv ``` Test download may be achieved by way of the server URL appended with the alias. For example if the server were called 'demo.filewave.ch', then the URL from the above configuration would be: `https://demo.filewave.ch/plugins_custom/` However, a file should be addressed directly. Taking the paint.csv as an example: `https://demo.filewave.ch/plugins_custom/paint.csv` Accessing this URL in a browser should show the contents or download the file. #### Plugin Data Source Now an Apache share has been created with populated files, a Data Source may be configured to use HTTP for access to the files. [](https://kb.filewave.com/uploads/images/gallery/2023-08/CRd9APkxQWl3aNsQ-image.png)Other Data Source settings should be configured as desired.
# Troubleshooting # Custom Grafana Dashboard - YML Files not being processed ## **What** A custom Grafana dashboard may stop processing data from YML files after the FileWave API key is regenerated. When that happens, Grafana keeps using the old `bearer_token_file`, so the YML-backed targets cannot authenticate. ## **When/Why** When you use [3.1.2 Testing the Prometheus Scrape](https://kb.filewave.com/books/dashboard-grafana/page/312-testing-the-prometheus-scrape "3.1.2 Testing the Prometheus Scrape") while setting up a custom Dashboard with a YML file, the targets may show “DOWN,” as shown below. Dashboard widgets that depend on those targets will not populate.  ## **How** To fix this, SSH to the FileWave Server and remove `bearer_token_file`. Restart FileWave Server so it regenerates the file with the current API key. Hosted customers should contact FileWave Support; support often handles custom YML uploads and can remove the file for you. ``` rm /usr/local/etc/filewave/prometheus/conf.d/bearer_token_file /usr/local/bin/fwcontrol server restart ``` # Resolving “Login failed: User sync failed” Error in Grafana ## What This article explains how to resolve the “Login failed: User sync failed” error when an administrator signs in to the FileWave Dashboard through Grafana. [](https://kb.filewave.com/uploads/images/gallery/2024-06/9oGAS9jainT09TCk-image.png) ## When/Why This error occurs when a FileWave administrator account uses a username that conflicts with Grafana. The most common case is a FileWave Central administrator named “admin”, since Grafana also uses an internal “admin” account. The conflict can appear when that administrator tries to open the FileWave Dashboard through Grafana. ## How Avoid using “admin” as a FileWave administrator username. Use the steps below for a built-in administrator account. If the affected administrator comes from [LDAP](https://kb.filewave.com/books/identity-provider-idp-integration/page/use-ldap-groups-for-filewave-central-administrator-access "LDAP Admin Integration") or an [IdP](https://kb.filewave.com/books/identity-provider-idp-integration/page/admin-login-using-an-idp-provider "Admin Login in Using an IdP Provider"), rename or adjust the account in that identity source instead. 1. **Access FileWave Central:** - Open FileWave Central. - Navigate to Preferences -> Manage Administrators. 2. **Rename the “admin” Account:** - Identify if an “admin” user exists. - Rename this user to a specific named account, such as a real administrator name. - Ensure the new username is unique and does not conflict with other system usernames. 3. **Create Named Accounts:** - Create individual named accounts for each administrator. - Named administrator accounts help prevent this Grafana conflict and make audit trails easier to understand. 4. **Update Login Credentials:** - Inform administrators whose usernames changed. - Update any saved login credentials in browsers or password managers accordingly. ## Related Links - [Managing FileWave Administrators](https://kb.filewave.com/books/filewave-central-anywhere/page/managing-filewave-administrators "Managing FileWave Administrators") ## Digging Deeper Grafana uses a default “admin” account during initial setup. If FileWave also has an administrator named “admin”, Grafana user synchronization can fail because the username is already reserved or in use. Named accounts also improve accountability because administrator activity can be tied to a person instead of a shared generic login. For FileWave administrator-account setup, see the related administrator-management article above.