Scylla Documentation Logo Documentation
  • Server
    • Scylla Open Source
    • Scylla Enterprise
    • Scylla Alternator
  • Cloud
    • Scylla Cloud
    • Scylla Cloud Docs
  • Tools
    • Scylla Manager
    • Scylla Monitoring Stack
    • Scylla Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu
Scylla The start-all.sh command

The start-all.sh command¶

Scylla-Monitoring is container-based, the simplest way to configure and start the monitoring is with the start-all.sh command.

The start-all.sh script is a small utility that sets the dashboards and starts the containers with the appropriate configuration.

General Options¶

-h Help, Print the help, and exit.

–version print the current Scylla-Monitoring stack version, and exit.

-l local. Use the host network. This is important when one of the containers need access to an application that runs on the host. For example, when Scylla-Manager runs on the localhost next to the monitoring. Because the monitoring applications run inside containers by default, their local IP address (127.0.0.1) is the container’s local IP address. You cannot use port mapping when using the -l flag

-A bind-to-ip-address Bind the listening-address to an explicit IP address.

-D encapsulate docker param Allows passing additional parameters to all the docker containers.

Grafana Related Commands¶

-G path/to/grafana data-dir Use an external directory for the Grafana database. This flag places the Grafana data directory outside of its container, and by doing that makes it persistent. This is only important if you are creating your own dashboards using the Grafana GUI and wish to keep them. If not used, each run of the containers will clear all of Grafana’s information.

-v comma-separated versions Each Scylla version comes with its own set of dashboards. By default, Grafana starts with the two latest versions. The -v flag allows specifying a specific version or versions.

-M scylla-manager version Each Scylla-Manager version has its own dashboard. By default, Grafana starts with the latest Scylla Manager version.  The -M flag allows specifying a specific version.

-j dashboard Allows adding dashboards to Grafana, multiple parameters are supported.

-c grafana environment variable Grafana allows overridden its configuration from the environment. The -c flag allows adding an environment variable to Grafana and altering its configuration by doing so.

-g grafana port Override the default Grafana port. This is done using port mapping. Note that the port mapping does not work when using the host network.

-a admin password Allows specifying the admin password.

-Q Grafana anonymous role By default, anonymous users have admin privileges. That means they can create and edit dashboards. The -Q fag change this behavior by setting the role privileges to one of Admin, Editor, or Viewer.

Prometheus Related Commands¶

-d path/to/data-dir Use an external directory for the Prometheus data directory. This flag places the Prometheus data directory outside of its container, and by doing that makes it persistent.

Note

Specifying an external directory is important for systems in production. Without it, every restart of the monitoring stack will result in metrics lost.

-p prometheus-port Override the default Prometheus port. This is done using port mapping. Note that the port mapping does not work when using the host network.

-b command-line options Allows adding command-line options that will be passed to the Prometheus server.

-s scylla-target-file Specify the location of the Scylla target files. This file contains the IP addresses of the Scylla nodes.

-n node-target-file Scylla Monitoring collects OS metrics (Disk, network, etc.) using an agent called node_exporter. By default, Scylla Monitoring assumes that there is a node_exporter running beside each Scylla node. For situations that this is not the case, for example, Scylla runs inside a container, and the relevant metrics are of the host machine, it is possible to specify a target file for the node_exporter agents.

-N manager target file Specify the location of the Scylla Manager target file.

-R prometheus-alert-file By default, Prometheus alert rules are found in prometheus.rules.yml in the prometheus directory. The -R flag allows specifying a different location.

-L manager-address Using Scylla Manager Consul API to resolve the servers’ IP address. When using this option, Prometheus will ignore the target files even if they are explicitly passed in the command line.

Alertmanager¶

-m alertmanager-port Override the default Alertmanager port. This is done using port mapping. Note that port mapping does not work when using the host network.

-r alert-manager-config By default, the Alertmanager takes its configuration from rule_config.yml in the prometheus directory. The -r override it to another file.prometheus

-C alertmanager-commands Allows adding an arbitrary command line to the alertmanager container starting command.

  • Getting Started
    • Install Scylla
      • Scylla Unified Installer (relocatable executable)
      • Air-gapped Server Installation
      • What is in each RPM
      • Scylla Housekeeping and how to disable it
      • Scylla Developer Mode
      • Scylla Configuration Reference
    • Configure Scylla
    • Scylla Requirements
      • System Requirements
      • OS Support by Platform and Version
      • Scylla in a Shared Environment
    • Cassandra Query Language (CQL)
      • CQLSh the CQL shell
      • Data Definition
      • Data Manipulation
      • Expiring Data with Time to Live (TTL)
      • Additional Information
      • Security
      • Data Types
      • Appendices
      • Definitions
      • Materialized Views
      • Functions
      • JSON
      • Global Secondary Indexes
      • Additional Information
      • Compaction
      • Consistency Levels
      • Reserved Keywords
      • Non-reserved Keywords
    • CQLSh: the CQL shell
    • Scylla Drivers
      • Scylla CQL Drivers
      • Scylla DynamoDB Drivers
    • Migrate to Scylla
      • Migration Process from Cassandra to Scylla
      • Scylla and Apache Cassandra Compatibility
      • Migration Tools Overview
    • Integration Solutions
      • Integrate Scylla with Spark
      • Integrate Scylla with KairosDB
      • Integrate Scylla with Presto
      • Integrate Scylla with Elasticsearch
      • Integrate Scylla with Kubernetes
      • Integrate Scylla with the JanusGraph Graph Data System
      • Integrate Scylla with DataDog
      • Integrate Scylla with Kafka
      • Integrate Scylla with IOTA Chronicle
      • Integrate Scylla with Spring
      • Shard-Aware Kafka Connector for Scylla
      • Install Scylla with Ansible
      • Integrate Scylla with Databricks
    • Tutorials
  • Scylla for Administrators
    • Administration Guide
    • Procedures
      • Cluster Management
      • Backup & Restore
      • Change Configuration
      • Maintenance
      • Best Practices
      • Benchmarking Scylla
      • Migrate from Cassandra to Scylla
      • Disable Housekeeping
    • Security
      • Scylla Security Checklist
      • Enable Authentication
      • Enable and Disable Authentication Without Downtime
      • Generate a cqlshrc File
      • Reset Authenticator Password
      • Enable Authorization
      • Grant Authorization CQL Reference
      • Role Based Access Control (RBAC)
      • Scylla Auditing Guide
      • Encryption: Data in Transit Client to Node
      • Encryption: Data in Transit Node to Node
      • Generating a self-signed Certificate Chain Using openssl
      • Encryption at Rest
      • LDAP Authentication
      • LDAP Authorization (Role Management)
    • Admin Tools
      • Nodetool Reference
      • CQLSh
      • REST
      • Tracing
      • scylla-sstable
      • SSTableLoader
      • cassandra-stress
      • SSTabledump
      • SSTable2json
      • SSTable Index
      • Scylla Logs
      • Seastar Perftune
    • Scylla Manager
      • Scylla Manager Docs
      • Upgrade Scylla Manager
      • Monitoring Support Matrix
    • Scylla Monitoring Stack
      • Latest Version
      • Upgrade Scylla Monitoring Stack
      • Monitoring Support Matrix
    • Scylla Operator
    • Upgrade Procedures
      • Scylla Enterprise
      • Scylla Open Source
      • Scylla Open Source to Scylla Enterprise
      • Scylla Manager
      • Scylla Monitoring
      • Scylla AMI
    • System Configuration
      • System Configuration Guide
      • scylla.yaml
      • Scylla Snitches
    • Benchmarking Scylla
  • Scylla for Developers
    • Learn To Use Scylla
      • Scylla University
      • Course catalog
      • Scylla Essentials
      • Basic Data Modeling
      • Advanced Data Modeling
      • MMS - Learn by Example
      • Care-Pet an IoT Use Case and Example
    • CQLSh
    • Apache Cassandra Query Language (CQL)
    • Scylla Alternator
    • Scylla Features
      • Scylla Open Source Features
      • Scylla Enterprise Features
    • Scylla Drivers
      • Scylla CQL Drivers
      • Scylla DynamoDB Drivers
  • Scylla Architecture
    • Scylla Ring Architecture
    • Scylla Fault Tolerance
    • Consistency Level Console Demo
    • Scylla Anti-Entropy
      • Scylla Hinted Handoff
      • Scylla Read Repair
      • Scylla Repair
    • SSTable
      • Scylla SSTable - 2.x
      • Scylla SSTable - 3.x
    • Compaction Strategies
  • Troubleshooting Scylla
    • Errors and Support
      • Report a Scylla problem
      • Error Messages
      • Change Log Level
    • Scylla Startup
      • Ownership Problems
      • Scylla will not Start
      • Scylla Python Script broken
    • Cluster and Node
      • Failed Decommission Problem
      • Cluster Timeouts
      • Node Joined With No Data
      • SocketTimeoutException
      • NullPointerException
    • Data Modeling
      • Scylla Large Partitions Table
      • Scylla Large Rows and Cells Table
      • Large Partitions Hunting
    • Data Storage and SSTables
      • Space Utilization Increasing
      • Disk Space is not Reclaimed
      • SSTable Corruption Problem
      • Pointless Compactions
      • Limiting Compaction
    • CQL
      • Time Range Query Fails
      • COPY FROM Fails
      • CQL Connection Table
      • Reverse queries fail
    • Scylla Monitor and Manager
      • Manager and Monitoring integration
      • Manager lists healthy nodes as down
  • Knowledge Base
    • Upgrading from experimental CDC
    • Compaction
    • Counting all rows in a table is slow
    • CQL Query Does Not Display Entire Result Set
    • When CQLSh query returns partial results with followed by “More”
    • Run Scylla and supporting services as a custom user:group
    • Decoding Stack Traces
    • Snapshots and Disk Utilization
    • DPDK mode
    • Debug your database with Flame Graphs
    • How to Change gc_grace_seconds for a Table
    • Gossip in Scylla
    • Increase Permission Cache to Avoid Non-paged Queries
    • How does Scylla LWT Differ from Apache Cassandra ?
    • Map CPUs to Scylla Shards
    • Scylla Memory Usage
    • NTP Configuration for Scylla
    • POSIX networking for Scylla
    • Scylla consistency quiz for administrators
    • Recreate RAID devices
    • How to Safely Increase the Replication Factor
    • Scylla and Spark integration
    • Increase Scylla resource limits over systemd
    • Scylla Seed Nodes
    • How to Set up a Swap Space
    • Scylla Snapshots
    • Stopping a local repair
    • System Limits
    • How to flush old tombstones from a table
    • Time to Live (TTL) and Compaction
    • Scylla Nodes are Unresponsive
    • Update a Primary Key
    • Using the perf utility with Scylla
    • Configure Scylla Networking with Multiple NIC/IP Combinations
  • Scylla University
  • Scylla FAQ
  • Contribute to Scylla
  • Glossary
  • Create an issue

On this page

  • The start-all.sh command
    • General Options
    • Grafana Related Commands
    • Prometheus Related Commands
    • Alertmanager
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon
© 2022, ScyllaDB. All rights reserved.
Last updated on 22 September 2021.
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.2.1