- Elasticsearch Guide: other versions:
- What is Elasticsearch?
- What’s new in 8.10
- Set up Elasticsearch
- Installing Elasticsearch
- Run Elasticsearch locally
- Configuring Elasticsearch
- Important Elasticsearch configuration
- Secure settings
- Auditing settings
- Circuit breaker settings
- Cluster-level shard allocation and routing settings
- Miscellaneous cluster settings
- Cross-cluster replication settings
- Discovery and cluster formation settings
- Field data cache settings
- Health Diagnostic settings
- Index lifecycle management settings
- Index management settings
- Index recovery settings
- Indexing buffer settings
- License settings
- Local gateway settings
- Logging
- Machine learning settings
- Monitoring settings
- Node
- Networking
- Node query cache settings
- Search settings
- Security settings
- Shard request cache settings
- Snapshot and restore settings
- Transforms settings
- Thread pools
- Watcher settings
- Advanced configuration
- Important system configuration
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Max file size check
- Maximum size virtual memory check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- All permission check
- Discovery configuration check
- Bootstrap Checks for X-Pack
- Starting Elasticsearch
- Stopping Elasticsearch
- Discovery and cluster formation
- Add and remove nodes in your cluster
- Full-cluster restart and rolling restart
- Remote clusters
- Plugins
- Upgrade Elasticsearch
- Index modules
- Mapping
- Text analysis
- Overview
- Concepts
- Configure text analysis
- Built-in analyzer reference
- Tokenizer reference
- Token filter reference
- Apostrophe
- ASCII folding
- CJK bigram
- CJK width
- Classic
- Common grams
- Conditional
- Decimal digit
- Delimited payload
- Dictionary decompounder
- Edge n-gram
- Elision
- Fingerprint
- Flatten graph
- Hunspell
- Hyphenation decompounder
- Keep types
- Keep words
- Keyword marker
- Keyword repeat
- KStem
- Length
- Limit token count
- Lowercase
- MinHash
- Multiplexer
- N-gram
- Normalization
- Pattern capture
- Pattern replace
- Phonetic
- Porter stem
- Predicate script
- Remove duplicates
- Reverse
- Shingle
- Snowball
- Stemmer
- Stemmer override
- Stop
- Synonym
- Synonym graph
- Trim
- Truncate
- Unique
- Uppercase
- Word delimiter
- Word delimiter graph
- Character filters reference
- Normalizers
- Index templates
- Data streams
- Ingest pipelines
- Example: Parse logs
- Enrich your data
- Processor reference
- Append
- Attachment
- Bytes
- Circle
- Community ID
- Convert
- CSV
- Date
- Date index name
- Dissect
- Dot expander
- Drop
- Enrich
- Fail
- Fingerprint
- Foreach
- Geo-grid
- GeoIP
- Grok
- Gsub
- HTML strip
- Inference
- Join
- JSON
- KV
- Lowercase
- Network direction
- Pipeline
- Redact
- Registered domain
- Remove
- Rename
- Reroute
- Script
- Set
- Set security user
- Sort
- Split
- Trim
- Uppercase
- URL decode
- URI parts
- User agent
- Aliases
- Search your data
- Collapse search results
- Filter search results
- Highlighting
- Long-running searches
- Near real-time search
- Paginate search results
- Retrieve inner hits
- Retrieve selected fields
- Search across clusters
- Search multiple data streams and indices
- Search shard routing
- Search templates
- Search with synonyms
- Sort search results
- kNN search
- Semantic search
- Searching with query rules
- Query DSL
- Aggregations
- Bucket aggregations
- Adjacency matrix
- Auto-interval date histogram
- Categorize text
- Children
- Composite
- Date histogram
- Date range
- Diversified sampler
- Filter
- Filters
- Frequent item sets
- Geo-distance
- Geohash grid
- Geohex grid
- Geotile grid
- Global
- Histogram
- IP prefix
- IP range
- Missing
- Multi Terms
- Nested
- Parent
- Random sampler
- Range
- Rare terms
- Reverse nested
- Sampler
- Significant terms
- Significant text
- Terms
- Time series
- Variable width histogram
- Subtleties of bucketing range fields
- Metrics aggregations
- Pipeline aggregations
- Average bucket
- Bucket script
- Bucket count K-S test
- Bucket correlation
- Bucket selector
- Bucket sort
- Change point
- Cumulative cardinality
- Cumulative sum
- Derivative
- Extended stats bucket
- Inference bucket
- Max bucket
- Min bucket
- Moving function
- Moving percentiles
- Normalize
- Percentiles bucket
- Serial differencing
- Stats bucket
- Sum bucket
- Bucket aggregations
- Geospatial analysis
- EQL
- SQL
- Overview
- Getting Started with SQL
- Conventions and Terminology
- Security
- SQL REST API
- SQL Translate API
- SQL CLI
- SQL JDBC
- SQL ODBC
- SQL Client Applications
- SQL Language
- Functions and Operators
- Comparison Operators
- Logical Operators
- Math Operators
- Cast Operators
- LIKE and RLIKE Operators
- Aggregate Functions
- Grouping Functions
- Date/Time and Interval Functions and Operators
- Full-Text Search Functions
- Mathematical Functions
- String Functions
- Type Conversion Functions
- Geo Functions
- Conditional Functions And Expressions
- System Functions
- Reserved keywords
- SQL Limitations
- Scripting
- Data management
- ILM: Manage the index lifecycle
- Tutorial: Customize built-in policies
- Tutorial: Automate rollover
- Index management in Kibana
- Overview
- Concepts
- Index lifecycle actions
- Configure a lifecycle policy
- Migrate index allocation filters to node roles
- Troubleshooting index lifecycle management errors
- Start and stop index lifecycle management
- Manage existing indices
- Skip rollover
- Restore a managed data stream or index
- Data tiers
- Autoscaling
- Monitor a cluster
- Roll up or transform your data
- Set up a cluster for high availability
- Snapshot and restore
- Secure the Elastic Stack
- Elasticsearch security principles
- Start the Elastic Stack with security enabled automatically
- Manually configure security
- Updating node security certificates
- User authentication
- Built-in users
- Service accounts
- Internal users
- Token-based authentication services
- User profiles
- Realms
- Realm chains
- Security domains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- JWT authentication
- Integrating with other authentication systems
- Enabling anonymous access
- Looking up users without authentication
- Controlling the user cache
- Configuring SAML single-sign-on on the Elastic Stack
- Configuring single sign-on to the Elastic Stack using OpenID Connect
- User authorization
- Built-in roles
- Defining roles
- Role restriction
- Security privileges
- Document level security
- Field level security
- Granting privileges for data streams and aliases
- Mapping users and groups to roles
- Setting up field and document level security
- Submitting requests on behalf of other users
- Configuring authorization delegation
- Customizing roles and authorization
- Enable audit logging
- Restricting connections with IP filtering
- Securing clients and integrations
- Operator privileges
- Troubleshooting
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Common Kerberos exceptions
- Common SAML issues
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- Failures due to relocation of the configuration files
- Limitations
- Watcher
- Command line tools
- elasticsearch-certgen
- elasticsearch-certutil
- elasticsearch-create-enrollment-token
- elasticsearch-croneval
- elasticsearch-keystore
- elasticsearch-node
- elasticsearch-reconfigure-node
- elasticsearch-reset-password
- elasticsearch-saml-metadata
- elasticsearch-service-tokens
- elasticsearch-setup-passwords
- elasticsearch-shard
- elasticsearch-syskeygen
- elasticsearch-users
- How to
- Troubleshooting
- Fix common cluster issues
- Diagnose unassigned shards
- Add a missing tier to the system
- Allow Elasticsearch to allocate the data in the system
- Allow Elasticsearch to allocate the index
- Indices mix index allocation filters with data tiers node roles to move through data tiers
- Not enough nodes to allocate all shard replicas
- Total number of shards for an index on a single node exceeded
- Total number of shards per node has been reached
- Troubleshooting corruption
- Fix data nodes out of disk
- Fix master nodes out of disk
- Fix other role nodes out of disk
- Start index lifecycle management
- Start Snapshot Lifecycle Management
- Restore from snapshot
- Multiple deployments writing to the same snapshot repository
- Addressing repeated snapshot policy failures
- Troubleshooting an unstable cluster
- Troubleshooting discovery
- Troubleshooting monitoring
- Troubleshooting transforms
- Troubleshooting Watcher
- Troubleshooting searches
- Troubleshooting shards capacity health issues
- REST APIs
- API conventions
- Common options
- REST API compatibility
- Autoscaling APIs
- Behavioral Analytics APIs
- Compact and aligned text (CAT) APIs
- cat aliases
- cat allocation
- cat anomaly detectors
- cat component templates
- cat count
- cat data frame analytics
- cat datafeeds
- cat fielddata
- cat health
- cat indices
- cat master
- cat nodeattrs
- cat nodes
- cat pending tasks
- cat plugins
- cat recovery
- cat repositories
- cat segments
- cat shards
- cat snapshots
- cat task management
- cat templates
- cat thread pool
- cat trained model
- cat transforms
- Cluster APIs
- Cluster allocation explain
- Cluster get settings
- Cluster health
- Health
- Cluster reroute
- Cluster state
- Cluster stats
- Cluster update settings
- Nodes feature usage
- Nodes hot threads
- Nodes info
- Prevalidate node removal
- Nodes reload secure settings
- Nodes stats
- Cluster Info
- Pending cluster tasks
- Remote cluster info
- Task management
- Voting configuration exclusions
- Create or update desired nodes
- Get desired nodes
- Delete desired nodes
- Get desired balance
- Reset desired balance
- Cross-cluster replication APIs
- Data stream APIs
- Document APIs
- Enrich APIs
- EQL APIs
- Features APIs
- Fleet APIs
- Find structure API
- Graph explore API
- Index APIs
- Alias exists
- Aliases
- Analyze
- Analyze index disk usage
- Clear cache
- Clone index
- Close index
- Create index
- Create or update alias
- Create or update component template
- Create or update index template
- Create or update index template (legacy)
- Delete component template
- Delete dangling index
- Delete alias
- Delete index
- Delete index template
- Delete index template (legacy)
- Exists
- Field usage stats
- Flush
- Force merge
- Get alias
- Get component template
- Get field mapping
- Get index
- Get index settings
- Get index template
- Get index template (legacy)
- Get mapping
- Import dangling index
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists (legacy)
- List dangling indices
- Open index
- Refresh
- Resolve index
- Rollover
- Shrink index
- Simulate index
- Simulate template
- Split index
- Unfreeze index
- Update index settings
- Update mapping
- Index lifecycle management APIs
- Create or update lifecycle policy
- Get policy
- Delete policy
- Move to step
- Remove policy
- Retry policy
- Get index lifecycle management status
- Explain lifecycle
- Start index lifecycle management
- Stop index lifecycle management
- Migrate indices, ILM policies, and legacy, composable and component templates to data tiers routing
- Ingest APIs
- Info API
- Licensing APIs
- Logstash APIs
- Machine learning APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendars
- Create datafeeds
- Create filters
- Delete calendars
- Delete datafeeds
- Delete events from calendar
- Delete filters
- Delete forecasts
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Estimate model memory
- Flush jobs
- Forecast jobs
- Get buckets
- Get calendars
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get model snapshots
- Get model snapshot upgrade statistics
- Get overall buckets
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Reset jobs
- Revert model snapshots
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filters
- Update jobs
- Update model snapshots
- Upgrade model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Delete data frame analytics jobs
- Evaluate data frame analytics
- Explain data frame analytics
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Preview data frame analytics
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Update data frame analytics jobs
- Machine learning trained model APIs
- Clear trained model deployment cache
- Create or update trained model aliases
- Create part of a trained model
- Create trained models
- Create trained model vocabulary
- Delete trained model aliases
- Delete trained models
- Get trained models
- Get trained models stats
- Infer trained model
- Start trained model deployment
- Stop trained model deployment
- Update trained model deployment
- Migration APIs
- Node lifecycle APIs
- Query rules APIs
- Reload search analyzers API
- Repositories metering APIs
- Rollup APIs
- Script APIs
- Search APIs
- Search Application APIs
- Searchable snapshots APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Clear privileges cache
- Clear API key cache
- Clear service account token caches
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Create or update users
- Create service account tokens
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete service account token
- Delete users
- Disable users
- Enable users
- Enroll Kibana
- Enroll node
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Get service accounts
- Get service account credentials
- Get token
- Get user privileges
- Get users
- Grant API keys
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect prepare authentication
- OpenID Connect authenticate
- OpenID Connect logout
- Query API key information
- Update API key
- Bulk update API keys
- SAML prepare authentication
- SAML authenticate
- SAML logout
- SAML invalidate
- SAML complete logout
- SAML service provider metadata
- SSL certificate
- Activate user profile
- Disable user profile
- Enable user profile
- Get user profiles
- Suggest user profile
- Update user profile data
- Has privileges user profile
- Create Cross-Cluster API key
- Update Cross-Cluster API key
- Snapshot and restore APIs
- Snapshot lifecycle management APIs
- SQL APIs
- Synonyms APIs
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Migration guide
- Release notes
- Elasticsearch version 8.10.4
- Elasticsearch version 8.10.3
- Elasticsearch version 8.10.2
- Elasticsearch version 8.10.1
- Elasticsearch version 8.10.0
- Elasticsearch version 8.9.2
- Elasticsearch version 8.9.1
- Elasticsearch version 8.9.0
- Elasticsearch version 8.8.2
- Elasticsearch version 8.8.1
- Elasticsearch version 8.8.0
- Elasticsearch version 8.7.1
- Elasticsearch version 8.7.0
- Elasticsearch version 8.6.2
- Elasticsearch version 8.6.1
- Elasticsearch version 8.6.0
- Elasticsearch version 8.5.3
- Elasticsearch version 8.5.2
- Elasticsearch version 8.5.1
- Elasticsearch version 8.5.0
- Elasticsearch version 8.4.3
- Elasticsearch version 8.4.2
- Elasticsearch version 8.4.1
- Elasticsearch version 8.4.0
- Elasticsearch version 8.3.3
- Elasticsearch version 8.3.2
- Elasticsearch version 8.3.1
- Elasticsearch version 8.3.0
- Elasticsearch version 8.2.3
- Elasticsearch version 8.2.2
- Elasticsearch version 8.2.1
- Elasticsearch version 8.2.0
- Elasticsearch version 8.1.3
- Elasticsearch version 8.1.2
- Elasticsearch version 8.1.1
- Elasticsearch version 8.1.0
- Elasticsearch version 8.0.1
- Elasticsearch version 8.0.0
- Elasticsearch version 8.0.0-rc2
- Elasticsearch version 8.0.0-rc1
- Elasticsearch version 8.0.0-beta1
- Elasticsearch version 8.0.0-alpha2
- Elasticsearch version 8.0.0-alpha1
- Dependencies and versions
Set up basic security for the Elastic Stack plus secured HTTPS traffic
editSet up basic security for the Elastic Stack plus secured HTTPS traffic
editWhen you enable TLS on the HTTP layer it provides an additional layer of security to ensure that all communications to and from your cluster are encrypted.
When you run the elasticsearch-certutil
tool in http
mode, the tool asks
several questions about how you want to generate certificates. While there are
numerous options, the following choices result in certificates that should
work for most environments.
Prerequisites
editComplete all steps in Set up basic security for the Elastic Stack.
Encrypt HTTP client communications for Elasticsearch
edit- On every node in your cluster, stop Elasticsearch and Kibana if they are running.
-
On any single node, from the directory where you installed Elasticsearch, run the Elasticsearch HTTP certificate tool to generate a Certificate Signing Request (CSR).
./bin/elasticsearch-certutil http
This command generates a
.zip
file that contains certificates and keys to use with Elasticsearch and Kibana. Each folder contains aREADME.txt
explaining how to use these files.-
When asked if you want to generate a CSR, enter
n
. -
When asked if you want to use an existing CA, enter
y
. -
Enter the path to your CA. This is the absolute path to
the
elastic-stack-ca.p12
file that you generated for your cluster. - Enter the password for your CA.
-
Enter an expiration value for your certificate. You can enter the
validity period in years, months, or days. For example, enter
90D
for 90 days. -
When asked if you want to generate one certificate per node, enter
y
.Each certificate will have its own private key, and will be issued for a specific hostname or IP address.
- When prompted, enter the name of the first node in your cluster. Use the same node name that you used when generating node certificates.
-
Enter all hostnames used to connect to your first node. These hostnames will be added as DNS names in the Subject Alternative Name (SAN) field in your certificate.
List every hostname and variant used to connect to your cluster over HTTPS.
- Enter the IP addresses that clients can use to connect to your node.
- Repeat these steps for each additional node in your cluster.
-
When asked if you want to generate a CSR, enter
- After generating a certificate for each of your nodes, enter a password for your private key when prompted.
-
Unzip the generated
elasticsearch-ssl-http.zip
file. This compressed file contains one directory for both Elasticsearch and Kibana./elasticsearch |_ README.txt |_ http.p12 |_ sample-elasticsearch.yml
/kibana |_ README.txt |_ elasticsearch-ca.pem |_ sample-kibana.yml
-
On every node in your cluster, complete the following steps:
-
Copy the relevant
http.p12
certificate to the$ES_PATH_CONF
directory. -
Edit the
elasticsearch.yml
file to enable HTTPS security and specify the location of thehttp.p12
security certificate.xpack.security.http.ssl.enabled: true xpack.security.http.ssl.keystore.path: http.p12
-
Add the password for your private key to the secure settings in Elasticsearch.
./bin/elasticsearch-keystore add xpack.security.http.ssl.keystore.secure_password
- Start Elasticsearch.
-
Copy the relevant
Encrypt HTTP client communications for Kibana
editBrowsers send traffic to Kibana and Kibana sends traffic to Elasticsearch. These communication channels are configured separately to use TLS. You encrypt traffic between Kibana and Elasticsearch, and then encrypt traffic between your browser and Kibana.
Encrypt traffic between Kibana and Elasticsearch
editWhen you ran the elasticsearch-certutil
tool with the http
option, it
created a /kibana
directory containing an elasticsearch-ca.pem
file. You
use this file to configure Kibana to trust the Elasticsearch CA for the HTTP
layer.
-
Copy the
elasticsearch-ca.pem
file to the Kibana configuration directory, as defined by the$KBN_PATH_CONF
path. -
Open
kibana.yml
and add the following line to specify the location of the security certificate for the HTTP layer.elasticsearch.ssl.certificateAuthorities: $KBN_PATH_CONF/elasticsearch-ca.pem
-
Add the following line to specify the HTTPS URL for your Elasticsearch cluster.
elasticsearch.hosts: https://<your_elasticsearch_host>:9200
- Restart Kibana.
Encrypt traffic between your browser and Kibana
editYou create a server certificate and private key for Kibana. Kibana uses this server certificate and corresponding private key when receiving connections from web browsers.
When you obtain a server certificate, you must set its subject alternative name (SAN) correctly to ensure that browsers will trust it. You can set one or more SANs to the Kibana server’s fully-qualified domain name (FQDN), hostname, or IP address. When choosing the SAN, pick whichever attribute you’ll use to connect to Kibana in your browser, which is likely the FQDN.
The following instructions create a Certificate Signing Request (CSR) for Kibana. A CSR contains information that a CA uses to generate and sign a security certificate. The certificate can be trusted (signed by a public, trusted CA) or untrusted (signed by an internal CA). A self-signed or internally-signed certificate is acceptable for development environments and building a proof of concept, but should not be used in a production environment.
Before going to production, use a trusted CA such as Let’s Encrypt or your organization’s internal CA to sign the certificate. Using a signed certificate establishes browser trust for connections to Kibana for internal access or on the public internet.
-
Generate a server certificate and private key for Kibana.
./bin/elasticsearch-certutil csr -name kibana-server -dns example.com,www.example.com
The CSR has a common name (CN) of
kibana-server
, a SAN ofexample.com
, and another SAN ofwww.example.com
.This command generates a
csr-bundle.zip
file by default with the following contents:/kibana-server |_ kibana-server.csr |_ kibana-server.key
-
Unzip the
csr-bundle.zip
file to obtain thekibana-server.csr
unsigned security certificate and thekibana-server.key
unencrypted private key. -
Send the
kibana-server.csr
certificate signing request to your internal CA or trusted CA for signing to obtain a signed certificate. The signed file can be in different formats, such as a.crt
file likekibana-server.crt
. -
Open
kibana.yml
and add the following lines to configure Kibana to access the server certificate and unencrypted private key.server.ssl.certificate: $KBN_PATH_CONF/kibana-server.crt server.ssl.key: $KBN_PATH_CONF/kibana-server.key
$KBN_PATH_CONF
contains the path for the Kibana configuration files. If you installed Kibana using archive distributions (zip
ortar.gz
), the path defaults to$KBN_HOME/config
. If you used package distributions (Debian or RPM), the path defaults to/etc/kibana
. -
Add the following line to
kibana.yml
to enable TLS for inbound connections.server.ssl.enabled: true
- Start Kibana.
After making these changes, you must always access Kibana via HTTPS. For
example, https://<your_kibana_host>.com
.
Next: Configure Beats security
Configure Beats security
editBeats are open source data shippers that you install as agents on your servers to send operational data to Elasticsearch. Each Beat is a separately installable product. The following steps cover configuring security for Metricbeat. Follow these steps for each additional Beat you want to configure security for.
Prerequisites
editInstall Metricbeat using your preferred method.
You cannot connect to the Elastic Stack or configure assets for Metricbeat before completing the following steps.
Create roles for Metricbeat
editTypically, you need to create the following separate roles:
- setup role for setting up index templates and other dependencies
- monitoring role for sending monitoring information
- writer role for publishing events collected by Metricbeat
- reader role for Kibana users who need to view and create visualizations that access Metricbeat data
These instructions assume that you are using the default name for Metricbeat indices. If the indicated index names are not listed, or you are using a custom name, enter it manually when defining roles and modify the privileges to match your index naming pattern.
To create users and roles from Stack Management in Kibana, select Roles or Users from the side navigation.
Next: Create a setup role
Create a setup role and user
editAdministrators who set up Metricbeat typically need to load mappings, dashboards, and other objects used to index data into Elasticsearch and visualize it in Kibana.
Setting up Metricbeat is an admin-level task that requires extra privileges. As a best practice, grant the setup role to administrators only, and use a more restrictive role for event publishing.
- Create the setup role:
- Enter metricbeat_setup as the role name.
- Choose the monitor and manage_ilm cluster privileges.
-
On the metricbeat-\* indices, choose the manage and write privileges.
If the metricbeat-\* indices aren’t listed, enter that pattern into the list of indices.
- Create the setup user:
- Enter metricbeat_setup as the user name.
- Enter the username, password, and other user details.
-
Assign the following roles to the metricbeat_setup user:
Role Purpose metricbeat_setup
Set up Metricbeat.
kibana_admin
Load dependencies, such as example dashboards, if available, into Kibana
ingest_admin
Set up index templates and, if available, ingest pipelines
Next: Create a monitoring role
Create a monitoring role and user
editTo send monitoring data securely, create a monitoring user and grant it the necessary privileges.
You can use the built-in beats_system
user, if it’s available in your
environment. Because the built-in users are not available in Elastic Cloud,
these instructions create a user that is explicitly used for monitoring
Metricbeat.
-
If you’re using the built-in
beats_system
user, on any node in your cluster, run theelasticsearch-reset-password
utility to set the password for that user:This command resets the password for the
beats_system
user to an auto-generated value../bin/elasticsearch-reset-password -u beats_system
If you want to set the password to a specific value, run the command with the interactive (
-i
) parameter../bin/elasticsearch-reset-password -i -u beats_system
- Create the monitoring role:
- Enter metricbeat_monitoring as the role name.
- Choose the monitor cluster privilege.
- On the .monitoring-beats-\* indices, choose the create_index and create_doc privileges.
- Create the monitoring user:
- Enter metricbeat_monitoring as the user name.
- Enter the username, password, and other user details.
-
Assign the following roles to the metricbeat_monitoring user:
Role Purpose metricbeat_monitoring
Monitor Metricbeat.
kibana_admin
Use Kibana
monitoring_user
Use Stack Monitoring in Kibana to monitor Metricbeat
Next: Create a writer role
Create a writer role and user
editUsers who publish events to Elasticsearch need to create and write to Metricbeat indices. To minimize the privileges required by the writer role, use the setup role to pre-load dependencies. This section assumes that you’ve created the setup role.
- Create the writer role:
- Enter metricbeat_writer as the role name.
- Choose the monitor and read_ilm cluster privileges.
- On the metricbeat-\* indices, choose the create_doc, create_index, and view_index_metadata privileges.
- Create the writer user:
- Enter metricbeat_writer as the user name.
- Enter the username, password, and other user details.
-
Assign the following roles to the metricbeat_writer user:
Role Purpose metricbeat_writer
Monitor Metricbeat
remote_monitoring_collector
Collect monitoring metrics from Metricbeat
remote_monitoring_agent
Send monitoring data to the monitoring cluster
Next: Create a reader role
Create a reader role and user
editKibana users typically need to view dashboards and visualizations that contain Metricbeat data. These users might also need to create and edit dashboards and visualizations. Create the reader role to assign proper privileges to these users.
- Create the reader role:
- Enter metricbeat_reader as the role name.
- On the metricbeat-\* indices, choose the read privilege.
-
Under Kibana, click Add Kibana privilege.
- Under Spaces, choose Default.
- Choose Read or All for Discover, Visualize, Dashboard, and Metrics.
- Create the reader user:
- Enter metricbeat_reader as the user name.
- Enter the username, password, and other user details.
-
Assign the following roles to the metricbeat_reader user:
Role Purpose metricbeat_reader
Read Metricbeat data.
monitoring_user
Allow users to monitor the health of Metricbeat itself. Only assign this role to users who manage Metricbeat
beats_admin
Create and manage configurations in Beats central management. Only assign this role to users who need to use Beats central management.
Next: Configure Metricbeat to use TLS
Configure Metricbeat to use TLS
editBefore starting Metricbeat, you configure the connections to Elasticsearch and Kibana. You can configure authentication to send data to your secured cluster using basic authentication, API key authentication, or Public Key Infrastructure (PKI) certificates.
The following instructions use the credentials for the metricbeat_writer
and metricbeat_setup
users that you created. If you need a greater level of
security, we recommend using PKI certificates.
After configuring connections to Elasticsearch and Kibana, you’ll enable the
elasticsearch-xpack
module and configure that module to use HTTPS.
In production environments, we strongly recommend using a separate cluster (referred to as the monitoring cluster) to store your data. Using a separate monitoring cluster prevents production cluster outages from impacting your ability to access your monitoring data. It also prevents monitoring activities from impacting the performance of your production cluster.
-
On the node where you
generated certificates for the HTTP layer,
navigate to the
/kibana
directory. -
Copy the
elasticsearch-ca.pem
certificate to the directory where you installed Metricbeat. -
Open the
metricbeat.yml
configuration file and configure the connection to Elasticsearch.Under
output.elasticsearch
, specify the following fields:output.elasticsearch: hosts: ["<your_elasticsearch_host>:9200"] protocol: "https" username: "metricbeat_writer" password: "<password>" ssl: certificate_authorities: ["elasticsearch-ca.pem"] verification_mode: "certificate"
-
hosts
- Specifies the host where your Elasticsearch cluster is running.
-
protocol
-
Indicates the protocol to use when connecting to Elasticsearch.
This value must be
https
. -
username
-
Name of the user with privileges required to publish events to
Elasticsearch. The
metricbeat_writer
user that you created has these privileges. -
password
-
Password for the indicated
username
. -
certificate_authorities
-
Indicates the path to the local
.pem
file that contains your CA’s certificate.
-
-
Configure the connection to Kibana.
Under
setup.kibana
, specify the following fields:setup.kibana host: "https://<your_elasticsearch_host>:5601" ssl.enabled: true username: "metricbeat_setup" password: "p@ssw0rd"
-
hosts
-
The URLs of the Elasticsearch instances to use for all your
queries. Ensure that you include
https
in the URL. -
username
-
Name of the user with privileges required to set up dashboards in Kibana. The
metricbeat_setup
user that you created has these privileges. -
password
-
Password for the indicated
username
.
-
-
Enable the
elasticsearch-xpack
module../metricbeat modules enable elasticsearch-xpack
-
Modify the
elasticsearch-xpack
module to use HTTPS. This module collects metrics about Elasticsearch.Open
/modules.d/elasticsearch-xpack.yml
and specify the following fields:- module: elasticsearch xpack.enabled: true period: 10s hosts: ["https://<your_elasticsearch_host>:9200"] username: "remote_monitoring_user" password: "<password>" ssl: enabled: true certificate_authorities: ["elasticsearch-ca.pem"] verification_mode: "certificate"
Configuring SSL is required when monitoring a node with encrypted traffic. See Configure SSL for Metricbeat.
-
hosts
-
Specifies the host where your Elasticsearch cluster is running.
Ensure that you include
https
in the URL. -
username
-
Name of the user with privileges to collect metric data. The
built-in
monitoring_user
user has these privileges. Alternatively, you can create a user and assign it themonitoring_user
role. -
password
-
Password for the indicated
username
. -
certificate_authorities
-
Indicates the path to the local
.pem
file that contains your CA’s certificate.
-
-
If you want to use the predefined assets for parsing, indexing, and visualizing your data, run the following command to load these assets:
./metricbeat setup -e
-
Start Elasticsearch, and then start Metricbeat.
./metricbeat -e
-e
is optional and sends output to standard error instead of the configured log output. -
Log in to Kibana, open the main menu, and click Stack Monitoring.
You’ll see cluster alerts that require your attention and a summary of the available monitoring metrics for Elasticsearch. Click any of the header links on the available cards to view additional information.
On this page
- Sign your own certificates
- Sign certificates with a central CA
- Prerequisites
- Encrypt HTTP client communications for Elasticsearch
- Encrypt HTTP client communications for Kibana
- Encrypt traffic between Kibana and Elasticsearch
- Encrypt traffic between your browser and Kibana
- Configure Beats security
- Prerequisites
- Create roles for Metricbeat
- Configure Metricbeat to use TLS