Upgrading to v2

v2 is a full redesign of the library. This guide covers every breaking change and how to migrate your code.

Dependency

# v1
{:logpoint_api, "~> 1.0.0"}

# v2
{:logpoint_api, "~> 2.0.0"}

The HTTP client changed from HTTPoison to Req, and Joken was added for JWT-authenticated endpoints (alert rules, repos).

Client setup

The plain credentials map is replaced by a Client struct built via the facade.

# v1
credentials = %{
  ip: "192.168.1.10",
  username: "admin",
  secret_key: "mysecret",
  verify_ssl: false
}

# v2
client = LogpointApi.client("https://192.168.1.10", "admin", "mysecret", ssl_verify: false)

Key differences:

• ip is now a full URL (base_url)
• verify_ssl is renamed to ssl_verify
• SSL verification defaults to true (was false in v1)

Search

LogpointApi.Query is replaced by LogpointApi.search_params/4,5. run_search is back with the same polling behaviour as v1 — see the Polling for Search Results guide for details.

# v1
query = %LogpointApi.Query{
  query: "user=*",
  time_range: [1_714_986_600, 1_715_031_000],
  limit: 100,
  repos: ["127.0.0.1:5504"]
}
{:ok, result} = LogpointApi.run_search(credentials, query)

# v2
query = LogpointApi.search_params("user=*", 1_714_986_600, 1_715_031_000, 100, ["127.0.0.1:5504"])
{:ok, result} = LogpointApi.run_search(client, query)

Option names changed: :poll_interval → :polling_interval, :max_retries → :max_attempts. The timeout error is now {:error, :max_attempts_exceeded} (atom instead of string).

Incidents

All incident functions moved to LogpointApi.Core.Incident.

# v1
{:ok, incidents} = LogpointApi.incidents(credentials, start_time, end_time)
{:ok, _} = LogpointApi.resolve_incidents(credentials, ["id1"])
{:ok, _} = LogpointApi.add_comments(credentials, %{"id1" => ["note"]})

# v2
alias LogpointApi.Core.Incident

{:ok, incidents} = Incident.list(client, start_time, end_time)
{:ok, _} = Incident.resolve(client, ["id1"])

comment = LogpointApi.comment("id1", "note")
{:ok, _} = Incident.add_comments(client, [comment])

New in v2: list/4 and list_states/4 accept an optional filters map.

Removed modules

New in v2

These domains are entirely new and have no v1 equivalent:

• Alert Rules — LogpointApi.Core.AlertRule with builder pattern via LogpointApi.rule/1
• Email Notifications — builder via LogpointApi.email_notification/2
• HTTP Notifications — builder via LogpointApi.http_notification/3
• Logpoint Repos — LogpointApi.Core.LogpointRepo
• User-Defined Lists — LogpointApi.Core.UserDefinedList
• Incident filtering — optional filters map on list/4 and list_states/4

See the LogpointApi module docs for full usage examples.