Log Services

Revision as of 19:09, 11 October 2016

DreamFactory 2.3.1 introduces the Log service. With Log services you can use a simple REST API to log any activities directly from your application or from DreamFactory platform using scripting services. The Log service currently supports integration with Logstash.

Logstash

The Logstash Log service allows you to easily connect your DreamFactory instance to a Logstash service listening for input on UDP, TCP, or HTTP protocol. Once you create a DreamFactory Logstash service, you can POST all your application and/or custom DreamFactory logs (via scripting) to Logstash. This gives you the ability to utilize the powerful Elasticsearch and Kibana for data analysis and reporting purposes. Logstash is a native DreamFactory service and is supported by features such as role-service-access, lookup usage, live API documentation, and caching.

Configuration

Logstash log service is managed via the api/v2/system/service API endpoint under the system service and have the service_type logstash. You can retrieve the full service type information using the API api/v2/system/service_type/logstash.

Below is the format of a typical Logstash service configuration.

{
    //Choose a URL safe service name
    "name": "logstash",
    //Choose a label for your service
    "label": "logstash",
    //A short description of your service
    "description": "log",
    //Boolean flag to activate/inactivate your service
    "is_active": true,
    //Service type
    "type": "logstash",
    "config": {
        "host": "127.0.0.1",
        "port": 5699,
        "protocol": "udp"
    },
}

The following describes the configuration elements of this service type.

Host

String. Required. IP Address/Hostname of the machine running the Logstash service.

Port

Integer. Required. Port number that Logstash is listening on for inputs.

Protocol

String. Required. Network protocol/format that Logstash input is configured for. Supported options are GELF (UDP), HTTP, TCP, UDP

• GELF (UDP) - Choose this if your Logstash service is configured to accept GELF format - http://docs.graylog.org/en/2.1/pages/gelf.html.
• HTTP - Choose this if your Logstash service is configured to listen on HTTP protocol. Data is sent using JSON format.
• TCP - Choose this if your Logstash service is configured to listen on TCP protocol. Data is sent using JSON format.
• UDP - Choose this if your Logstash service is configured to listen on UDP protocol. Data is sent using JSON format.