-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This introduces wrapper adaptor over Webhook adaptor to send logs to DataDog HTTP log ingest endpoint.
- Loading branch information
Showing
7 changed files
with
171 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| defmodule Logflare.Backends.Adaptor.DatadogAdaptor do | ||
| @moduledoc """ | ||
| Wrapper module for `Logflare.Backends.Adaptor.WebhookAdaptor` to provide API | ||
| for DataDog logs ingestion endpoint. | ||
| """ | ||
|
|
||
| use TypedStruct | ||
|
|
||
| alias Logflare.Backends.Adaptor.WebhookAdaptor | ||
|
|
||
| typedstruct enforce: true do | ||
| field(:api_key, String.t()) | ||
| end | ||
|
|
||
| @behaviour Logflare.Backends.Adaptor | ||
|
|
||
| def child_spec(arg) do | ||
| %{ | ||
| id: __MODULE__, | ||
| start: {__MODULE__, :start_link, [arg]} | ||
| } | ||
| end | ||
|
|
||
| @impl Logflare.Backends.Adaptor | ||
| def start_link({source, backend}) do | ||
| backend = %{ | ||
| backend | ||
| | config: %{ | ||
| url: "https://http-intake.logs.datadoghq.com/api/v2/logs", | ||
| headers: %{ | ||
| "dd-api-key" => backend.config.api_key | ||
| } | ||
| } | ||
| } | ||
|
|
||
| WebhookAdaptor.start_link({source, backend}) | ||
| end | ||
|
|
||
| @impl Logflare.Backends.Adaptor | ||
| def ingest(pid, log_events, opts) do | ||
| new_events = | ||
| Enum.map(log_events, &translate_event/1) | ||
|
|
||
| WebhookAdaptor.ingest(pid, new_events, opts) | ||
| end | ||
|
|
||
| @impl Logflare.Backends.Adaptor | ||
| def execute_query(_ident, _query), do: {:error, :not_implemented} | ||
|
|
||
| @impl Logflare.Backends.Adaptor | ||
| def cast_config(params) do | ||
| {%{}, %{api_key: :string}} | ||
| |> Ecto.Changeset.cast(params, [:api_key]) | ||
| end | ||
|
|
||
| @impl Logflare.Backends.Adaptor | ||
| def validate_config(changeset) do | ||
| import Ecto.Changeset | ||
|
|
||
| changeset | ||
| |> validate_required([:api_key]) | ||
| end | ||
|
|
||
| defp translate_event(%Logflare.LogEvent{} = le) do | ||
| %Logflare.LogEvent{ | ||
| le | ||
| | body: %{ | ||
| message: Jason.encode!(le.body), | ||
| ddsource: "logflare", | ||
| service: le.source.name | ||
| } | ||
| } | ||
| end | ||
| end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| defmodule Logflare.Backends.Adaptor.DatadogAdaptorTest do | ||
| use Logflare.DataCase, async: false | ||
|
|
||
| alias Logflare.Backends.Adaptor | ||
|
|
||
| @subject Logflare.Backends.Adaptor.DatadogAdaptor | ||
|
|
||
| doctest @subject | ||
|
|
||
| describe "cast and validate" do | ||
| test "API key is required" do | ||
| changeset = Adaptor.cast_and_validate_config(@subject, %{}) | ||
|
|
||
| refute changeset.valid? | ||
|
|
||
| changeset = | ||
| Adaptor.cast_and_validate_config(@subject, %{ | ||
| "api_key" => "foobarbaz" | ||
| }) | ||
|
|
||
| assert changeset.valid? | ||
| end | ||
| end | ||
|
|
||
| describe "logs ingestion" do | ||
| setup do | ||
| user = insert(:user) | ||
| source = insert(:source, user: user) | ||
|
|
||
| backend = | ||
| insert(:backend, type: :datadog, sources: [source], config: %{api_key: "foo-bar"}) | ||
|
|
||
| pid = start_supervised!({@subject, {source, backend}}) | ||
| :timer.sleep(500) | ||
| [pid: pid, backend: backend, source: source] | ||
| end | ||
|
|
||
| test "sent logs are delivered", %{pid: pid, source: source, backend: backend} do | ||
| this = self() | ||
| ref = make_ref() | ||
|
|
||
| Tesla.Mock.mock_global(fn _req -> | ||
| send(this, ref) | ||
| %Tesla.Env{status: 200, body: ""} | ||
| end) | ||
|
|
||
| le = build(:log_event, source: source) | ||
|
|
||
| assert :ok == @subject.ingest(pid, [le], source_id: source.id, backend_id: backend.id) | ||
| assert_receive ^ref, 2000 | ||
| end | ||
|
|
||
| test "service field is set to source name", %{pid: pid, source: source, backend: backend} do | ||
| this = self() | ||
| ref = make_ref() | ||
|
|
||
| Tesla.Mock.mock_global(fn req -> | ||
| send(this, {ref, Jason.decode!(req.body)}) | ||
| %Tesla.Env{status: 200, body: ""} | ||
| end) | ||
|
|
||
| le = build(:log_event, source: source) | ||
|
|
||
| assert :ok == @subject.ingest(pid, [le], source_id: source.id, backend_id: backend.id) | ||
| assert_receive {^ref, [log_entry]}, 2000 | ||
| assert log_entry["service"] == source.name | ||
| end | ||
|
|
||
| test "message is JSON encoded log event", %{pid: pid, source: source, backend: backend} do | ||
| this = self() | ||
| ref = make_ref() | ||
|
|
||
| Tesla.Mock.mock_global(fn req -> | ||
| send(this, {ref, Jason.decode!(req.body)}) | ||
| %Tesla.Env{status: 200, body: ""} | ||
| end) | ||
|
|
||
| le = build(:log_event, source: source) | ||
|
|
||
| assert :ok == @subject.ingest(pid, [le], source_id: source.id, backend_id: backend.id) | ||
| assert_receive {^ref, [log_entry]}, 2000 | ||
| assert Jason.decode!(log_entry["message"]) == le.body | ||
| end | ||
| end | ||
| end |