Snappy compressed proto format

README.md

@@ -4,20 +4,22 @@ LokiLogger is an Elixir logger backend providing support for Logging to [Grafana
 
 [![Hex.pm Version](http://img.shields.io/hexpm/v/loki_logger.svg?style=flat)](https://hex.pm/packages/loki_logger)
 
-
 ## Known issues
 
 * "works-on-my-machine" level of quality. Love to get your feedback in the repo's Github issues
 
-## TODO
+## Features (and TODO)
 
-* async http call to backend.
-* snappy compressed proto format in the HTTP Body instead of JSON. 
-* proper unit tests.
-* http post retry strategy on temporary loki backend failure or network hiccups.
-* authentication with basic auth and/or Oauth2 reverse proxy.
-* support for tenant header (X-Scope-OrgID) in multi-tenancy scenario's.  
-* CI build integration (e.g. TravisCI) 
+* [x] Elixir Logger formatting
+* [x] Elixir Logger metadata
+* [x] Loki Scope-Org-Id header for multi-tenancy
+* [x] Timezone aware
+* [X] Snappy compressed proto format in the HTTP Body  
+* [ ] Async http call to backend.
+* [ ] Proper unit tests.
+* [ ] HTTP post retry strategy on temporary loki backend failure or network hiccups.
+* [ ] Authentication with basic auth and/or Oauth2 reverse proxy.
+* [ ] CI build integration (e.g. TravisCI) 
 
 ## Installation
 
@@ -26,7 +28,7 @@ The package can be installed by adding `loki_logger` to your list of dependencie
 ```elixir
 def deps do
   [
-    {:loki_logger, "~> 0.1.0"}
+    {:loki_logger, "~> 0.3.0"}
   ]
 end
 ```
@@ -39,6 +41,7 @@ Loki Logger's behavior is controlled using the application configuration environ
 
 * __loki_host__ : the hostname of the syslog server e.g. http://localhost:3100
 * __loki_labels__ : the Loki log labels used to select the log stream in e.g. Grafana 
+* __loki_scope_org_id__: optional tenant ID for multitenancy. Currently not (yet?) supported in Grafana when enforced with `auth_enabled: true` in Loki config 
 * __level__: logging threshold. Messages "above" this threshold will be discarded. The supported levels, ordered by precedence are :debug, :info, :warn, :error.
 * __format__: the format message used to print logs. Defaults to: "$metadata level=$level $levelpad$message". It may also be a {module, function} tuple that is invoked with the log level, the message, the current timestamp and the metadata.
 * __metadata__: the metadata to be printed by $metadata. Defaults to to :all, which prints all metadata.
@@ -62,6 +65,14 @@ config :logger, :loki_logger,
        loki_host: "http://localhost:3100"
 ```
 
+# Protobuff lib regeneration
+
+only needed for development 
+
+```shell script
+protoc --proto_path=./lib/proto --elixir_out=./lib lib/proto/loki.proto 
+```
+
 ## License
 
 Loki Logger is copyright (c) 2019 Ward Bekker 

config/config.exs

@@ -9,6 +9,7 @@ config :logger, :loki_logger,
        metadata: :all,
        max_buffer: 300,
        loki_labels: %{application: "loki_logger_library", elixir_node: node()},
-       loki_host: "http://localhost:3100"
+       loki_host: "http://localhost:3100",
+       loki_scope_org_id: "acme_inc"
 
 config :elixir, :time_zone_database, Tzdata.TimeZoneDatabase

lib/logproto/gogo.proto

@@ -0,0 +1,144 @@
+// Protocol Buffers for Go with Gadgets
+//
+// Copyright (c) 2013, The GoGo Authors. All rights reserved.
+// http://github.com/gogo/protobuf
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//     * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//     * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+syntax = "proto2";
+package gogoproto;
+
+import "google/protobuf/descriptor.proto";
+
+option java_package = "com.google.protobuf";
+option java_outer_classname = "GoGoProtos";
+option go_package = "github.com/gogo/protobuf/gogoproto";
+
+extend google.protobuf.EnumOptions {
+    optional bool goproto_enum_prefix = 62001;
+    optional bool goproto_enum_stringer = 62021;
+    optional bool enum_stringer = 62022;
+    optional string enum_customname = 62023;
+    optional bool enumdecl = 62024;
+}
+
+extend google.protobuf.EnumValueOptions {
+    optional string enumvalue_customname = 66001;
+}
+
+extend google.protobuf.FileOptions {
+    optional bool goproto_getters_all = 63001;
+    optional bool goproto_enum_prefix_all = 63002;
+    optional bool goproto_stringer_all = 63003;
+    optional bool verbose_equal_all = 63004;
+    optional bool face_all = 63005;
+    optional bool gostring_all = 63006;
+    optional bool populate_all = 63007;
+    optional bool stringer_all = 63008;
+    optional bool onlyone_all = 63009;
+
+    optional bool equal_all = 63013;
+    optional bool description_all = 63014;
+    optional bool testgen_all = 63015;
+    optional bool benchgen_all = 63016;
+    optional bool marshaler_all = 63017;
+    optional bool unmarshaler_all = 63018;
+    optional bool stable_marshaler_all = 63019;
+
+    optional bool sizer_all = 63020;
+
+    optional bool goproto_enum_stringer_all = 63021;
+    optional bool enum_stringer_all = 63022;
+
+    optional bool unsafe_marshaler_all = 63023;
+    optional bool unsafe_unmarshaler_all = 63024;
+
+    optional bool goproto_extensions_map_all = 63025;
+    optional bool goproto_unrecognized_all = 63026;
+    optional bool gogoproto_import = 63027;
+    optional bool protosizer_all = 63028;
+    optional bool compare_all = 63029;
+    optional bool typedecl_all = 63030;
+    optional bool enumdecl_all = 63031;
+
+    optional bool goproto_registration = 63032;
+    optional bool messagename_all = 63033;
+
+    optional bool goproto_sizecache_all = 63034;
+    optional bool goproto_unkeyed_all = 63035;
+}
+
+extend google.protobuf.MessageOptions {
+    optional bool goproto_getters = 64001;
+    optional bool goproto_stringer = 64003;
+    optional bool verbose_equal = 64004;
+    optional bool face = 64005;
+    optional bool gostring = 64006;
+    optional bool populate = 64007;
+    optional bool stringer = 67008;
+    optional bool onlyone = 64009;
+
+    optional bool equal = 64013;
+    optional bool description = 64014;
+    optional bool testgen = 64015;
+    optional bool benchgen = 64016;
+    optional bool marshaler = 64017;
+    optional bool unmarshaler = 64018;
+    optional bool stable_marshaler = 64019;
+
+    optional bool sizer = 64020;
+
+    optional bool unsafe_marshaler = 64023;
+    optional bool unsafe_unmarshaler = 64024;
+
+    optional bool goproto_extensions_map = 64025;
+    optional bool goproto_unrecognized = 64026;
+
+    optional bool protosizer = 64028;
+    optional bool compare = 64029;
+
+    optional bool typedecl = 64030;
+
+    optional bool messagename = 64033;
+
+    optional bool goproto_sizecache = 64034;
+    optional bool goproto_unkeyed = 64035;
+}
+
+extend google.protobuf.FieldOptions {
+    optional bool nullable = 65001;
+    optional bool embed = 65002;
+    optional string customtype = 65003;
+    optional string customname = 65004;
+    optional string jsontag = 65005;
+    optional string moretags = 65006;
+    optional string casttype = 65007;
+    optional string castkey = 65008;
+    optional string castvalue = 65009;
+
+    optional bool stdtime = 65010;
+    optional bool stdduration = 65011;
+    optional bool wktpointer = 65012;
+
+}