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

Fix few typos. #2126

Merged
merged 1 commit into from
Dec 11, 2023
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
4 changes: 2 additions & 2 deletions docker-build/lokiinit.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
echo "running loki init"

if [ -f /mnt/config/loki-config.yaml ]; then
echo "Config exsits loki-config.yaml"
echo "Config exists loki-config.yaml"
else
echo "Setting loki-config.yaml"
sed "s/ALERTMANAGER/$ALERT_MANAGER_ADDRESS/" /mnt/config/loki-config.template.yaml > /mnt/config/loki-config.yaml
fi
/usr/bin/loki --config.file=/mnt/config/loki-config.yaml --ingester.wal-enabled=false
/usr/bin/loki --config.file=/mnt/config/loki-config.yaml --ingester.wal-enabled=false
2 changes: 1 addition & 1 deletion docker-build/prometheusinit.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/sh -e
echo "running prometheus init"
if [ -f /etc/prometheus/conf/prometheus.yml ]; then
echo "Config exsits /etc/prometheus/conf/prometheus.yml"
echo "Config exists /etc/prometheus/conf/prometheus.yml"
else
echo "Setting prometheus.yml"
DST="/etc/prometheus/conf/"
Expand Down
4 changes: 2 additions & 2 deletions docker-build/promtailinit.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
echo "running promtail init"

if [ -f /etc/promtail/config.yml ]; then
echo "Config exsits promtail-config.yaml"
echo "Config exists promtail-config.yaml"
else
echo "Setting promtail-config.yaml"
sed "s/ALERTMANAGER/$ALERT_MANAGER_ADDRESS/" /etc/promtail/promtail-config.template.yaml > /etc/promtail/config.yml
fi
/usr/bin/promtail --config.file=/etc/promtail/config.yml /etc/promtail/config.yml
/usr/bin/promtail --config.file=/etc/promtail/config.yml /etc/promtail/config.yml
6 changes: 3 additions & 3 deletions docs/source/install/monitor-without-docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Scylla Monitoring uses the following components:
* Grafana

The common scenario for users who use their own standalone installation, is that they already have such a server and would like to consolidate.
We assume that that you already have Prometheus and Grafana running but we will add minimal installation instruction for all componenents.
We assume that that you already have Prometheus and Grafana running but we will add minimal installation instruction for all components.

We suggest that you follow the installation instruction of each of those products from their official documentation. It is also recommended that all servers will run as a service.

Expand Down Expand Up @@ -497,7 +497,7 @@ Enable the Plugin
Grafana will not load unsigned plugins, for that you will need to enable it with Grafana. Edit Grafana ``grafana.ini`` file and add
the line ``allow_loading_unsigned_plugins: scylladb-scylla-datasource``.

See more about it the `Grafana configurtion`_.
See more about it the `Grafana configuration`_.

.. _`grafana configurtion`: https://grafana.com/docs/grafana/latest/administration/configuration/#allow_loading_unsigned_plugins
.. _`grafana configuration`: https://grafana.com/docs/grafana/latest/administration/configuration/#allow_loading_unsigned_plugins

4 changes: 2 additions & 2 deletions docs/source/reference/metrics.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ scylla_database_querier_cache_drops: 'Counts querier cache lookups that found a
scylla_database_querier_cache_lookups: 'Counts querier cache lookups (paging queries)'
scylla_database_querier_cache_misses: 'Counts querier cache lookups that failed to find a cached querier'
scylla_database_querier_cache_population: 'The number of entries currently in the querier cache.'
scylla_database_querier_cache_resource_based_evictions: 'Counts querier cache entries that were evicted to free up resources (limited by reader concurency limits) necessary to create new readers.'
scylla_database_querier_cache_resource_based_evictions: 'Counts querier cache entries that were evicted to free up resources (limited by reader concurrency limits) necessary to create new readers.'
scylla_database_querier_cache_time_based_evictions: 'Counts querier cache entries that timed out and were evicted.'
scylla_database_queued_reads: 'Holds the number of currently queued read operations.'
scylla_database_reads_memory_consumption: 'Holds the amount of memory consumed by current read operations issued on behalf of streaming '
Expand Down Expand Up @@ -382,7 +382,7 @@ scylla_stall_detector_reported: 'Total number of reported stalls, look in the tr
scylla_storage_proxy_coordinator_background_reads: 'number of currently pending background read requests'
scylla_storage_proxy_coordinator_background_replica_writes_failed_local_node: 'number of replica writes that timed out or failed after CL was reachedon a local Node'
scylla_storage_proxy_coordinator_background_writes: 'number of currently pending background write requests'
scylla_storage_proxy_coordinator_cas_background: 'how many paxos operations are still running after a result was alredy returned'
scylla_storage_proxy_coordinator_cas_background: 'how many paxos operations are still running after a result was already returned'
scylla_storage_proxy_coordinator_cas_foreground: 'how many paxos operations that did not yet produce a result are running'
scylla_storage_proxy_coordinator_cas_prune: 'how many times paxos prune was done after successful cas operation'
scylla_storage_proxy_coordinator_completed_reads_local_node: 'number of data read requests that completedon a local Node'
Expand Down
2 changes: 1 addition & 1 deletion docs/source/use-monitoring/advisor/systemOverload.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ There could be multiple indications that a system is overloaded:
* Timeouts
* Requests shed - Requests are shed (dropped) when the system cannot process requests fast enough.
* CPU at 100% when no background process (like compaction or repair) runs.
* Ques are getting filled.
* Queues are getting filled.

If you ruled out data-model problems and hardware failure, this could indicate you need to scale the system.

4 changes: 2 additions & 2 deletions grafana/plugins/scylla-plugin/dist/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Scylla/Apache Cassandra Backend Plugin

The plugin is currently in Alpha and not ready for comercial usage.
The plugin is currently in Alpha and not ready for commercial usage.

[![CircleCI](https://circleci.com/gh/grafana/simple-datasource-backend/tree/master.svg?style=svg)](https://circleci.com/gh/grafana/simple-datasource-backend/tree/master)

Expand All @@ -9,7 +9,7 @@ This plugin allows connecting Scylla or Appahe Cassandra to Grafana.
## What is Scylla Grafana Data Source Backend Plugin?

A [Backend plugins](https://grafana.com/docs/grafana/latest/developers/plugins/backend/) is a type of data-source plugin that runs on the server.
That means that that from IP connectivity, your Database (Scylla or Appache Cassanra) should be accessible from the grafana server.
That means that that from IP connectivity, your Database (Scylla or Apache Cassanra) should be accessible from the grafana server.


## Getting started
Expand Down
8 changes: 4 additions & 4 deletions grafana/scylla-cql.template.json
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,7 @@
"step": 1
}
],
"description": "Number of CQL INSERT commands generated by intenal operations",
"description": "Number of CQL INSERT commands generated by internal operations",
"title": "CQL Internal Insert"
},
{
Expand All @@ -582,7 +582,7 @@
"step": 1
}
],
"description": "Number of CQL SELECT commands generated by intenal operations",
"description": "Number of CQL SELECT commands generated by internal operations",
"title": "CQL Internal Reads"
},
{
Expand All @@ -598,7 +598,7 @@
"step": 1
}
],
"description": "Number of CQL DELETE commands generated by intenal operations",
"description": "Number of CQL DELETE commands generated by internal operations",
"description": "scylla_cql_deletes",
"title": "CQL Deletes"
},
Expand All @@ -615,7 +615,7 @@
"step": 1
}
],
"description": "Number of CQL UPDATE commands generated by intenal operations",
"description": "Number of CQL UPDATE commands generated by internal operations",
"description": "scylla_cql_updates",
"title": "CQL Updates"
}
Expand Down
6 changes: 3 additions & 3 deletions grafana/scylla-detailed.template.json
Original file line number Diff line number Diff line change
Expand Up @@ -1463,7 +1463,7 @@
}
],
"title": "Paxos Background operations",
"description" : "How many paxos operations are still running after a result was alredy returned"
"description" : "How many paxos operations are still running after a result was already returned"
},
{
"class": "text_panel",
Expand Down Expand Up @@ -1585,7 +1585,7 @@
}
],
"title": "LWT Write Unfinished - Repair Attempts",
"description" : "Number of Paxos-repairs of INSERT, UPDATE, or DELETE with conditions.\n\nA repair is necessary when a previous Paxos statement was partialy successful. A subsequent statement then may not proceed before completing the work of its predecessor. A repair is not guaranteed to succeed, the metric indicates the number of repair attempts made"
"description" : "Number of Paxos-repairs of INSERT, UPDATE, or DELETE with conditions.\n\nA repair is necessary when a previous Paxos statement was partially successful. A subsequent statement then may not proceed before completing the work of its predecessor. A repair is not guaranteed to succeed, the metric indicates the number of repair attempts made"
},
{
"class": "rps_panel",
Expand All @@ -1600,7 +1600,7 @@
}
],
"title": "LWT Read Unfinished - Repair Attempts",
"description" : "Number of Paxos-repairs of SELECT statement with SERIAL consistency.\n\nA repair is necessary when a previous Paxos statement was partialy successful. A subsequent statement then may not proceed before completing the work of its predecessor. A repair is not guaranteed to succeed, the metric indicates the number of repair attempts made"
"description" : "Number of Paxos-repairs of SELECT statement with SERIAL consistency.\n\nA repair is necessary when a previous Paxos statement was partially successful. A subsequent statement then may not proceed before completing the work of its predecessor. A repair is not guaranteed to succeed, the metric indicates the number of repair attempts made"
}
]
},
Expand Down
10 changes: 5 additions & 5 deletions prometheus/prom_rules/prometheus.rules.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ groups:
advisor: "cqlOptimization"
dashboard: "cql"
description: 'Some queries are non-prepared'
summary: non prepared statments
summary: non prepared statements
- alert: cql:non_paged_no_system
expr: cql:non_paged > 0
for: 10s
Expand All @@ -19,7 +19,7 @@ groups:
dashboard: "cql"
status: "1"
description: 'Some SELECT queries are non-paged'
summary: non paged statments
summary: non paged statements
- alert: cqlNoTokenAware
expr: cql:non_token_aware > 0
for: 10s
Expand All @@ -28,7 +28,7 @@ groups:
advisor: "cqlOptimization"
dashboard: "cql"
description: 'Some queries are not token-aware'
summary: non token aware statments
summary: non token aware statements
- alert: cqlAllowFiltering
expr: cql:allow_filtering > 0
for: 10s
Expand All @@ -46,7 +46,7 @@ groups:
advisor: "cqlOptimization"
dashboard: "cql"
description: 'Some queries use Consistency Level: ANY'
summary: non prepared statments
summary: non prepared statements
- alert: cqlCLAll
expr: cql:all_queries > 0
for: 10s
Expand All @@ -55,7 +55,7 @@ groups:
advisor: "cqlOptimization"
dashboard: "cql"
description: 'Some queries use Consistency Level: ALL'
summary: non prepared statments
summary: non prepared statements
- alert: nonBalancedcqlTraffic
expr: abs(rate(scylla_cql_updates{conditional="no"}[1m]) - scalar(avg(rate(scylla_cql_updates{conditional="no"}[1m]))))/scalar(stddev(rate(scylla_cql_updates{conditional="no"}[1m]))+100) > 2
for: 3m
Expand Down
4 changes: 2 additions & 2 deletions start-all.sh
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ elif [[ $(uname) == "Darwin" ]]; then
fi

function usage {
__usage="Usage: $(basename $0) [-h] [--version] [-e] [-d Prometheus data-dir] [-L resolve the servers from the manger running on the given address] [-G path to grafana data-dir] [-s scylla-target-file] [-n node-target-file] [-l] [-v comma separated versions] [-j additional dashboard to load to Grafana, multiple params are supported] [-c grafana environment variable, multiple params are supported] [-b Prometheus command line options] [-g grafana port ] [ -p prometheus port ] [-a admin password] [-m alertmanager port] [ -M scylla-manager version ] [-D encapsulate docker param] [-r alert-manager-config] [-R prometheus-alert-file] [-N manager target file] [-A bind-to-ip-address] [-C alertmanager commands] [-Q Grafana anonymous role (Admin/Editor/Viewer)] [-S start with a system specific dashboard set] [-T additional-prometheus-targets] [--no-loki] [--auto-restart] [--no-renderer] [-f alertmanager-dir]
__usage="Usage: $(basename $0) [-h] [--version] [-e] [-d Prometheus data-dir] [-L resolve the servers from the manager running on the given address] [-G path to grafana data-dir] [-s scylla-target-file] [-n node-target-file] [-l] [-v comma separated versions] [-j additional dashboard to load to Grafana, multiple params are supported] [-c grafana environment variable, multiple params are supported] [-b Prometheus command line options] [-g grafana port ] [ -p prometheus port ] [-a admin password] [-m alertmanager port] [ -M scylla-manager version ] [-D encapsulate docker param] [-r alert-manager-config] [-R prometheus-alert-file] [-N manager target file] [-A bind-to-ip-address] [-C alertmanager commands] [-Q Grafana anonymous role (Admin/Editor/Viewer)] [-S start with a system specific dashboard set] [-T additional-prometheus-targets] [--no-loki] [--auto-restart] [--no-renderer] [-f alertmanager-dir]

Options:
-h print this help and exit
Expand Down Expand Up @@ -552,7 +552,7 @@ for val in "${PROMETHEUS_COMMAND_LINE_OPTIONS_ARRAY[@]}"; do
if [[ $val = "--"* ]]; then
PROMETHEUS_COMMAND_LINE_OPTIONS+=" $val"
else
echo "Using single hyphen is depricated and will be removed in future version use -$val instead"
echo "Using single hyphen is deprecated and will be removed in future version use -$val instead"
PROMETHEUS_COMMAND_LINE_OPTIONS+=" -$val"
fi
done
Expand Down
4 changes: 2 additions & 2 deletions start-datadog.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
if [ -f env.sh ]; then
. env.sh
fi
usage="$(basename "$0") [-h] [-A DD_API_KEY ][-p ip:port address of prometheus ] [-d configuration directory] [-e enviroment variable, multiple params are supported] [-D encapsulate docker param] -- Start a datadog agent inside a container"
usage="$(basename "$0") [-h] [-A DD_API_KEY ][-p ip:port address of prometheus ] [-d configuration directory] [-e environment variable, multiple params are supported] [-D encapsulate docker param] -- Start a datadog agent inside a container"

while getopts ':hA:p:e:H:D:' option; do
case "$option" in
Expand Down Expand Up @@ -35,7 +35,7 @@ while getopts ':hA:p:e:H:D:' option; do
done

if [ -z "$DD_API_KEY" ]; then
printf "\nDatagot API keys are not pressent, exiting.\n"
printf "\nDatagot API keys are not present, exiting.\n"
exit 1
fi
if [ -z "$DATADOG_NAME" ]; then
Expand Down
2 changes: 1 addition & 1 deletion start-grafana.sh
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ for arg; do
unset LIMIT
fi
done
usage="$(basename "$0") [-h] [-v comma separated versions ] [-g grafana port ] [-G path to external dir] [-n grafana container name ] [-p ip:port address of prometheus ] [-j additional dashboard to load to Grafana, multiple params are supported] [-c grafana enviroment variable, multiple params are supported] [-x http_proxy_host:port] [-m alert_manager address] [-a admin password] [ -M scylla-manager version ] [-D encapsulate docker param] [-Q Grafana anonymous role (Admin/Editor/Viewer)] [-S start with a system specific dashboard set] [-P ldap_config_file] -- loads the prometheus datasource and the Scylla dashboards into an existing grafana installation"
usage="$(basename "$0") [-h] [-v comma separated versions ] [-g grafana port ] [-G path to external dir] [-n grafana container name ] [-p ip:port address of prometheus ] [-j additional dashboard to load to Grafana, multiple params are supported] [-c grafana environment variable, multiple params are supported] [-x http_proxy_host:port] [-m alert_manager address] [-a admin password] [ -M scylla-manager version ] [-D encapsulate docker param] [-Q Grafana anonymous role (Admin/Editor/Viewer)] [-S start with a system specific dashboard set] [-P ldap_config_file] -- loads the prometheus datasource and the Scylla dashboards into an existing grafana installation"

while getopts ':hlEg:n:p:v:a:x:c:j:m:G:M:D:A:S:P:L:Q:' option; do
case "$option" in
Expand Down