Sematext Integrations Guide
Sematext Cloud provides over 100 built-in integrations used to monitor all your systems, apps, services, websites, etc.
You can collect data from various systems and send them to Sematext Cloud where you can then analyze and visualize them using APM and logging tools, and set alerts on the behaviour of these systems. Once the Sematext Agent is installed, integrations provide monitoring capabilities for the following types of data:
- Metrics from your infrastructure or services running on it
- Logs from your applications, servers, etc.
- Events such as services starting or restarting, package installs and version updates, builds, deployments, alerts, etc. Events are graphed in timeseries charts and these charts can be correlated with metrics or logs components to enable faster troubleshooting.
To start monitoring and alerting for your infrastructure performance and logs you need to set up the Sematext Agent. Sematext Agent collects server, container, and Kubernetes metrics, network connections, process metrics, infrastructure inventory data, Docker and Kubernetes events, and more. It also performs service discovery and logs discovery, so you can easily set up monitoring for your services and logs.
After you install and activate an integration for a service you want to monitor, you can:
- Filter and analyze the metrics and configuration data
- Query your data and create custom dashboards
- Create alert rules to detect problems with your services, infrastructure, website, etc. and get alerted via one or more alert notification hooks.
- AWS EC2
- AWS ECS on AWS Fargate with AWS FireLens
- AWS ECS on AWS Fargate with AWS Logs
- AWS ECS on AWS EC2
- AWS S3 CloudTrail
- AWS CloudWatch Logs
- AWS Lambda
- Cloud IaaS / PaaS
- GitHub Webhook Events
- IBM Kubernetes Logs
- Kubernetes Audit
- Log Shippers
- Operating Systems
- Programming Languages
- Syslog Protocols
- Vercel Logs
- Apache Spark
- Apache Storm
- AWS (Amazon Web Services)
- Solr Cloud
- Big Panda
- Custom user defined webhooks
- Email as default system webhhook
- Microsoft Teams
Adding a New Integration¶
An App is core concept in Sematext. When adding monitoring you will start by creating an App for the desired integration type. Go to the Apps page to create a new App. Pick a solution type and all the available integrations for that solution will be listed. Hover over any integration card and click to create the respective App.
Next step is to pick your environment that runs the service you want to monitor.
After you select your environment, the agent installation page will show up, which gives you step-by-step instructions on how to install Sematext Agent.
To help speed up troubleshooting make use of Connected Apps. For example, connecting a Monitoring App to a Logs App will pre-select that Logs App when you decide to correlate metrics. When you receive an alert notification for an App, the alert notification will contain charts from connected Apps, and thus provide more information and context for you. You can connect any two Apps you have access to, regardless of their type. A single App can be connected to any number of other Apps.
To connect Apps go to App Table View and choose Connect App from Integration Menu.
Or navigate to the App and click on the Connect New App button on the top right of the page.
Notification Hooks Integrations¶
When an App is first created you may find that Sematext automatically created several App default, integration-specific alerts. User account email is used as a default notification hook to send those alert notifications. If you want to use any of the popular third party messaging services that you use in your operations workflow, you can do so by creating related notification hook integration.
App Table View¶
Once one or more Apps have been created, the Apps Table will display all the created Apps and provide overview as well as App menu from where you can:
- access and edit App settings
- create alerts and define alert rules
- connect two Apps
- invite other devops team members
- transfer or disable App
- get to monitoring installation instructions
You can also add new integrations and filter and search existing App using table search functionality. The App table contains following information:
- Type illustrated using integration type logo link to provide visual clue should App naming convention not include any reference to the type
- Application Name
- Next table column describes your Integration Plan and plans can be adjusted using App settings. For more information on infrastructure monitoring pricing or logging pricing check our website
- App Status indicator icons show your apps status and either green checkmark is used to indicate that App is sending data to our service, indexed and ready for IT systems monitoring
- Your role is defined in the last second column
Sematext Agent Installation¶
Sematext stores data received through the Elasticsearch API and also through a variety of Syslog protocols. In order for the Sematext Cloud to receive data from your systems you need to install an agent on them. Logs Apps require log shipper installation on your end, and information below explains the process.
Sematext exposes the Elasticsearch API which lets you: - send log events directly from your application, using any Elasticsearch library - send log events using a "log shipper" application such as Logstash, rsyslog, Apache Flume, Fluentd, or - anything that can output to Elasticsearch search for logs from your own application, or by configuring/adapting existing Elasticsearch UIs, such as Kibana - optionally define custom mappings for your log types, so you can tweak the way your logs are indexed
The basic settings for sending data using the Elasticsearch API are:
- host: logsene-receiver.sematext.com
- port: 80 (HTTP) or 443 (HTTPS)
- index: bb50181f-5fad-4639-b880-7c49e036ae02 (this is example app token and the unique one will be created for every logging app you create)
We accept Syslog messages using any log shipper and any Syslog library, as long as they either contain a valid token or the source IP is authorized. The basic settings for sending data using the Syslog protocols are:
- host: logsene-syslog-receiver.sematext.com
- port: 514 (TCP and UDP), 20514 (RELP) or 10514 (TLS)
- index: bb50181f-5fad-4639-b880-7c49e036ae02 (example tokene)
We accept JSON messages using any log shipper and any logging library, as long as they contain a valid token. The basic settings for sending data using the Socket protocols are:
- host: logsene-syslog-receiver.sematext.com
- port: 12201 (TCP and UDP)
- index: bb50181f-5fad-4639-b880-7c49e036ae02 (example token)
Two steps are required when creating a Monitoring App:
- Agent Installation
- Agent Setup
You need to add the Sematext repository and install Sematext Agent. It is available for various Linux distributions, various versions of Kubernetes, Containers, as well as infrastructure orchestration tools like Ansible, Puppet, and Chef. To install, simply choose your distribution and copy-paste commands from the screen.
App Agent Setup¶
App Agent collects performance metrics of your application (Solr, Elasticsearch, MySQL, Nginx, etc.). It can run in two different modes:
For more information check App Agent overview page
You'll start seeing your performance data in Sematext in a few minutes. If you do not see performance charts in 5 minutes, have a look at Troubleshooting page for tips and if nothing works give us a shout @Sematext or at email@example.com.
Recommendations for learning more about Sematext products and services: