share

# Index Events via Elasticsearch API

## The Essentials¶

Sematext Logs exposes the Elasticsearch API so you can:

When you use the API, here are the things you need to know:

• host name: logsene-receiver.sematext.com / logsene-receiver.eu.sematext.com (only if using Sematext Cloud Europe)
• port: 80 or 443 (depending on whether you want to use plain HTTP or HTTPS)
• index name: your Logs App token - note: this token should be kept secret (n.b. you can have N Logs Apps, each with its own token)

## Indexing¶

With the same REST API, you can index logs directly from your own application, or you can craft your own "log sender".

NOTE: If you are sending logs from your application use the Elasticsearch HTTP API. If you are sending logs from a Java application use Elasticsearch Java REST Client

Besides specifying your Logs App token as the index name, it's nice to have a field named "@timestamp". Its value should be a valid ISO 8601 timestamp. If you don't provide a timestamp, Sematext will add one when it receives your logs.

For example, you can send a log like this:

NOW=date "+%Y-%m-%dT%H:%M:%S%z"
curl -XPOST https://logsene-receiver.sematext.com/$YOUR_TOKEN_HERE/_doc/ -d ' { "@timestamp": "'$NOW'",
"message": "Hello World!"
}'


This will index a simple "hello world" message to Logs App. That event would have the current timestamp and will be indexed in the App whose token is specified.

Typically, you'd put events with different structures in different Apps. For example, syslog messages in one App, Apache logs in another App, etc. See this FAQ entry.

For performance reasons we highly recommend using the Bulk API, because it allows you to send multiple events with a single request. For example, the following request sends three events:

NOW=date "+%Y-%m-%dT%H:%M:%S%z"

echo '{ "index" : { "_index": "LOGS_APP_TOKEN_GOES_HERE" } }
{ "@timestamp": "'$NOW'", "severity_numeric" : 1 } { "index" : { "_index": "LOGS_APP_TOKEN_GOES_HERE" } } { "@timestamp": "'$NOW'", "message" : "hello again" }
{ "index" : { "_index": "LOGS_APP_TOKEN_GOES_HERE" } }
{ "@timestamp": "'\$NOW'", "alternate_message": "fields can be added and removed at will" }' > req

curl -XPOST https://logsene-receiver.sematext.com/_bulk --data-binary @req; echo


A mapping is a way to define how your logs are indexed - which fields are in each log event and how each field is indexed. Each Logs App comes with a default mappings definition which includes pre-defined fields. In addition to that Sematext automatically creates the mapping in each Logs App when you first ship your logs. Each App can have its own mapping and it can be changed at any time from within Sematext using the fields editor or by using the mappings and templates functionality. There are some special fields though.

• the @timestamp field is an ISO 8601 date. See Supported Date Formats.
• the geoip field is an object that contains a location geo point field (this works well if you're using Logstash)
• host, facility, severity, syslog-tag, source, and tags are Special Fields that are not analyzed, which enables only exact matches (you can still use wildcards, for example to search for web-server* and get web-server01)
• all string fields are analyzed by whitespace and lowercased by default, thus makign it possible to search for message:hello and match events with Hello World in the message field