First version

Author: fermino

.gitignore

@@ -0,0 +1 @@
+.idea

include/Message.h

@@ -0,0 +1,55 @@
+#ifndef GELF_MESSAGE_H
+#define GELF_MESSAGE_H
+
+// TODO add consts where needed!
+
+#include "ArduinoJson.h"
+// TODO: different amounts of memory depending on the platform!
+
+#ifdef ESP8266
+#include <ESP8266WiFi.h>
+#endif
+
+#define GRAYLOG_DEFAULT_HOST "graylog-default-host"
+
+class Message
+{
+public:
+    explicit Message(const char *short_message) {
+
+        _json["version"] = "1.1";
+#ifdef ESP8266
+        _json["host"] = WiFi.hostname();
+#else
+        _json["host"] = GRAYLOG_DEFAULT_HOST;
+#endif
+        _json["short_message"] = short_message;
+    }
+    template<typename T>
+    void set(const char *field, T value) {
+        if (strncmp("id", field, 2) == 0 || strncmp("_id", field, 3) == 0) {
+            return;
+        }
+
+        if (field[0] != '_') {
+            // TODO: prepend underscore!
+        }
+
+        // TODO: Check regex - ^[\w\.\-]*$
+
+        _json[field] = value;
+    }
+
+    unsigned int getEncodedLength() {
+        return measureJson(_json);
+    }
+    void encode(char *buffer, size_t buffer_size) {
+        serializeJson(_json, buffer, buffer_size);
+    }
+
+private:
+    // We could use the heap but whatever
+    StaticJsonDocument<512> _json;
+};
+
+#endif

include/Publisher.h

@@ -0,0 +1,16 @@
+#ifndef GELF_PUBLISHER_H
+#define GELF_PUBLISHER_H
+
+#include "Transport/Transport.h"
+#include "Message.h"
+
+class Publisher
+{
+public:
+    explicit Publisher(Transport *transport);
+    void publish(Message *message);
+private:
+    Transport *_transport = nullptr;
+};
+
+#endif

include/Transport/Transport.h

@@ -0,0 +1,12 @@
+#ifndef GELF_TRANSPORT_H
+#define GELF_TRANSPORT_H
+
+#include "../Message.h"
+
+class Transport
+{
+public:
+    virtual void send(Message *message) = 0;
+};
+
+#endif

include/Transport/UDPTransport.h

@@ -0,0 +1,24 @@
+#ifndef GELF_UDPTRANSPORT_H
+#define GELF_UDPTRANSPORT_H
+
+#include "Transport/Transport.h"
+#include "../Message.h"
+
+#include <ESP8266WiFi.h>
+#include <WiFiUdp.h>
+
+#define GRAYLOG_UDP_DEFAULT_PORT    12201
+
+class UDPTransport : public Transport
+{
+public:
+    explicit UDPTransport(char *host, int port = GRAYLOG_UDP_DEFAULT_PORT);
+    void send(Message *message) override;
+private:
+    char *_host = nullptr;
+    int _port = 0;
+
+    WiFiUDP _udp = WiFiUDP();
+};
+
+#endif

library.json

@@ -0,0 +1,26 @@
+{
+  "name": "gelf-embedded",
+  "version": "1.0.0",
+  "description": "An easy to use GELF (graylog) library for Arduino, ESP8266 and other embedded platforms",
+  "keywords": "esp8266, arduino, gelf, graylog, log, debug",
+  "repository":
+  {
+    "type": "git",
+    "url": "https://github.com/fermino/gelf-embedded.git"
+  },
+  "authors":
+  [
+    {
+      "name": "Fermín Olaiz",
+      "email": "[email protected]",
+      "url": "https://github.com/fermino"
+    }
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/fermino/gelf-embedded/",
+  "dependencies": {
+    "bblanchon/ArduinoJson":"^6.18.5"
+  },
+  "frameworks": "*",
+  "platforms": "*"
+}

src/Publisher.cpp

@@ -0,0 +1,9 @@
+#include "../include/Publisher.h"
+
+Publisher::Publisher(Transport *transport) {
+    _transport = transport;
+}
+
+void Publisher::publish(Message *message) {
+    _transport->send(message);
+}

src/Transport/UDPTransport.cpp

@@ -0,0 +1,24 @@
+#include "../../include/Transport/UDPTransport.h"
+
+UDPTransport::UDPTransport(char *host, int port)
+{
+    _host = host;
+    _port = port;
+}
+
+void UDPTransport::send(Message *message)
+{
+    _udp.beginPacket(_host, _port);
+
+    unsigned long length = message->getEncodedLength();
+    char buffer[length + 1];
+    message->encode(buffer, length); // Debería ser length + 1??
+    buffer[length] = '\0'; // This might be unnecessary
+
+    _udp.write(buffer);
+    _udp.endPacket();
+
+    // https://stackoverflow.com/questions/1098897/what-is-the-largest-safe-udp-packet-size-on-the-internet
+    // PS: We don't want to deal with chunking yet
+    //udp.begin(_port);
+}