Skip to content

Commit e2afc72

Browse files
committed
Tweaks to README
1 parent e11ef1d commit e2afc72

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

samples/speedystore/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Operation completed successfully
112112
Once completed, the exporter process, the pipeline and the '**metrics**' database have been created. You can use the SingleStore Studio, to confirm this. For example, in the screenshot below, you can see the newly created `**metrics**' database:
113113
![Screenshot showing SingleStore Studio with the 'metrics' database highlighted](images/02_MG_202508_metrics-database.png)
114114

115-
### Create the "S2MonitorUser"
115+
### Create the "S2MonitorUser" user
116116
Next, you need to create a specific user that Grafana can use to connect to the '**metrics**' database. After logging into SingleStore with the admin user, you can submit the `CREATE USER` and `GRANT` commands via the SingleStore CLI (or, from the SQL Editor within SingleStore Studio) to create the user and grant the user the desired permissions.
117117

118118
For example, the following command creates a user called `S2MonitorUser` and sets its password:
@@ -174,13 +174,14 @@ Or, you can import specific dashboards individually using the same script. For
174174

175175
`./monitoring/bin/deploy_dashboards.sh samples/speedystore/dashboards/clusterview.yaml`
176176

177-
### Validate
177+
### Validate everything is working
178178
Once the dashboards have been imported into Grafana, you should be all set to monitor the SingleStore instance embedded in SAS SpeedyStore.
179179

180180
To validate the configuration, sign into Grafana and review the SingleStore dashboards you've imported. All of the imported dashboards have the ***"sas-speedystore"*** and ***"singlestore"*** tags. While the data shown will vary based on user activity, all of the dashboards should be available with no errors or warning icons or messages.
181181

182182
## The Grafana Dashboards
183183
This is a list of the SingleStore dashboards included in this sample. Each dashboard name in the list is a link to more information about the dashboard in the SingleStore documentation including the metrics depicted and the types of questions they address.
184+
184185
* [Cluster View](https://docs.singlestore.com/db/v8.9/user-and-cluster-administration/cluster-health-and-performance/configure-monitoring/view-the-dashboards/#cluster-view)
185186
* [Detailed Cluster View by Node](https://docs.singlestore.com/db/v8.9/user-and-cluster-administration/cluster-health-and-performance/configure-monitoring/view-the-dashboards/#detailed-cluster-view-by-node)
186187
* [Disk Usage](https://docs.singlestore.com/db/v8.9/user-and-cluster-administration/cluster-health-and-performance/configure-monitoring/view-the-dashboards/#disk-usage)
@@ -191,6 +192,10 @@ This is a list of the SingleStore dashboards included in this sample. Each das
191192
* [Query History](https://docs.singlestore.com/db/v8.9/user-and-cluster-administration/cluster-health-and-performance/configure-monitoring/view-the-dashboards/#query-history)
192193
* [Resource Pool Monitoring](https://docs.singlestore.com/db/v8.9/user-and-cluster-administration/cluster-health-and-performance/configure-monitoring/view-the-dashboards/#resource-pool-monitoring)
193194

195+
NOTE: The following modifications have been made to the original SingleStore dashboards definitions:
196+
* the json files were renamed to use all lowercase and remove spaces;
197+
* the name of the datasource was changed from `monitoring` to `s2monitoring`; and,
198+
* the tags `sas-speedystore` and `singlestore` were added to the dashboards.
194199
## Acknowledgements
195200
Thank you to Michael Goddard (SAS Education) for all of his work sorting this out and allowing us to share it here.
196201

0 commit comments

Comments
 (0)