Skip to main content

Send Cyral logs to ELK stack

Follow the steps below to configure Cyral to output repository activity logs to ELK.

Set up an ELK stack#

Deploy AWS Elasticsearch Service#

Contact your Cyral support representative to get the deployment template for your cloud environment, and then follow the steps below.

Use the ELK Terraform template provided by the Cyral support team to deploy the AWS Elasticsearch service using Terraform. In the template for ELK, enter the appropriate values based on where you’d like to deploy the ELK cluster.

  • aws_region
  • key_name
  • vpc_id
  • subnets

NOTE: The ELK cluster must be deployed in the same VPC as your sidecar for it to receive logs from the sidecar. Verify that your AWS account has the appropriate IAM role to deploy the ELK cluster by running the following command:

aws iam get-role --role-name “AWSServiceRoleForAmazonElasticsearchService”

If this command yields an error, then set es_create_iam_service_linked_role in the Terraform template to true — otherwise, set it to false.

With the values populated in the Terraform template, deploy the ELK stack by running the following:

terraform initterraform apply

Once installation is complete, you will see the following output containing your Kibana endpoint.

Apply complete! Resources: 4 added, 1 changed, 0 destroyed.Outputs:kibana_access = To access kibana visit: http://3.134.48.235:5601

Connect Cyral to your ELK stack#

Now that the AWS Elasticsearch service is deployed, let's integrate it with Cyral.

  1. In the Cyral management console, click Integrations, find the ELK card, and click Configure or Setup.
  1. In the ELK configuration form, you will be prompted to enter the following:

    • Integration Name: Integration name of your choice.
    • Kibana URL: The Kibana server's hostname. If you're using Terraform, this matches the Terraform template provided by ELK (kibana.local, by default).
    • Elasticsearch URL: Address where Elasticsearch is available. By default, this is es.local:80.
  1. Click Save to connect the integration.
caution

Each sidecar that will send logs to this log destination will need to be deployed with its Log Integration set to the Integration Name you specified above.

When deploying new sidecars, make sure to choose the name of this Log Integration when you generate the template.

NOTE: Sidecars that are already deployed will need to be redeployed.

Monitor data activity in Kibana#

Once the ELK integration is configured, administrators will be able to view and monitor data repository activity logs in Kibana.

Prerequisites#

Generate sample log data#

If you haven't already done so, run a few queries to generate query logs.

  • If your repository is set to log all activity, any query will do.
  • If you have a policy that logs only certain types of activity, run a query that falls within the scope of the policy.

View logs#

Access the Kibana dashboard as shown here for your cloud platform:

In your browser, visit the Kibana dashboard address provided in the Terraform or Cloudformation output from your deployment. See Set up an ELK stack for deployment details.

To limit the view to show only query logs by, search for the log field endUser in the search bar.

Import the performance insights dashboard into Kibana#

Cyral provides a dashboard you can import into your Kibana to observe performance insights based on the query logs generated by your sidecars. Importing this also creates an index matching the pattern filebeat* to capture logs produced by sidecars.

  1. Download the Performance Insights Dashboard file by clicking Integrations: ELK: Configure and clicking the Download Kibana Dashboards button.

  2. Navigate to the Saved Objects tab in the Management page (in the sidebar), and click Import. You can expand the sidebar using the button in the bottom left of the screen to make navigation easier.

  3. Select the performance-insights-dashboard.ndjson file, check the toggle to Automatically overwrite all saved objects, and click open.

The Performance Insights dashboard should now be available, and you can find it by navigating to the Dashboards page (in the sidebar).

Next steps#