Sematext Integrations Guide
Sematext Cloud and on-premises IT monitoring system provides over 40 built-in infrastructure integrations used to monitor across all your systems, Apps, and services.
You can report data from various systems to the Sematext Cloud, analyze and visualize it using APM and logging tools, and set alerts on the behaviour of these systems. Once infrastructure agent is installed, integrations provide monitoring capabilities for the following type of data:
- Metrics and inventory data such as OS & Network, server, and much more depending on the metrics type your integration sends with control over how data is collected and shared within your organization.
Logs where stored data is received through the Elasticsearch API and also through a variety of Syslog protocols.
Events such as services starting or restarting, version updates, builds, deployments, alerts, etc. Events are graphed in timeseries charts and these charts can be shown next to metrics or logs components, and together added to your custom dashboards.
Essentially, you can report data from any system on your server or hosts by creating your own custom reports.
To start monitoring your IT infrastructure you need to set up the appropriate Sematext monitoring agent. You can choose from:
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 collects metrics for various integrations using App Agents. App Agents can also instrument JVM-based App to collect transaction traces and perform on demand profiling.
After you install and activate an integration, you can:
Filter and analyze the metrics and configuration data
Query your data and create custom dashboards
Create alert conditions to monitor problems with your services' performance with Sematext alerting tools
- Syslog Protocols
- Log Shippers
- Programming Languages
- Operating Systems
- Cloud IaaS / PaaS
- AWS EC2
- AWS CloudWatch Logs
- AWS (Amazon Web Services)
- Solr Cloud
- Apache Spark
- Apache Storm
- Email as default system webhhook
- Custom user defined webhooks
- Big Panda
- Microsoft Teams
Creating New Integration¶
Navigate to Integrations Overview. Three different integrations are available:
- Log Shipping and Management App
- Infrastructure and Application Performance Monitoring App
- Notification Hooks through various third party integrations, email, and system defined custom webhooks
Hover over any integration card and click to create respective App or a webhook. Initially, there will be no App status and count tag displayed in the left bottom corner of the card, but once related App(s) have been created tag will display the number of App, and grey and green tag colour are used to show if App are not or are receiving data respectively.
Image below illustrates an integration card being hovered over and the App status with the count tag displayed with one example App created.
New integration creation userflow is the same for both monitoring as well as logging App. While Apache monitoring App is being created you can also create complementary logs App as well. It makes perfect sense, and it is the only way to have full observability into performance and issues of the Apache server for example, and that particular piece of a IT infrastructure puzzle.
In other words, as monitoring App is being created you can create a logging App as well and vice versa. You can also invite other devops team members and provide them with the same tools and insights while using RBAC (role based access control) model to restrict or provide proper administrative user rights.
When an integration App is first created our IT system monitoring platform creates several App specific alerts. User account email is used as a default notification mechanism 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 webhook integration.
You will first need to create that third party service and obtain required API keys and/or other tokens in order to establish communication between that service and Sematext Cloud. Image below shows a third party notification webhook integration being created, Slack in this example.
App Table View¶
Once one or more Apps have been created, 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.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
- Integration Token is a unique system generated string that you will need to use on your system in order to install Sematext Integration Agent. It is required to authenticate and establish system connections so you can start sending data to the Sematext Cloud. Integration Agent installation will be covered in more depth in the following section.
- 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
- App owner is defined in the last second column
- Last, but not the least, App Settings dropdown menu is the last item in the apps table.
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 automatically 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.
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 the agent on them. Logging 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 as well as infrastructure orchestration tools like Ansible, Puppet, and Chef. Choose your distribution and install required packages. Once installed, move to the App Agent Setup step.
App Agent Setup¶
App Agent collects performance metrics of your application (Solr, Elasticsearch, HBase...). 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.
Register for free or Login into Sematext IT systems monitoring platform to get started and create your logs App. Upload your logs from all your servers to our centralized log management solution with Elasticsearch API and integrated Kibana, and experience the first true Hosted ELK Stack.
Recommendations for learning more about Sematext products and services:
- Infrastructure integrations documentation
- Our website
- For open-source integrations and other Sematext contribution to the open-source community, check our GitHub repositories.
- or just talk to us using chat located in right bottom corner of any page, and one of our engineers will help you navigate Sematext waters.