EndPointBlank (end_point_blank_elixir v0.6.0)

Copy Markdown

Summary

Functions

Configures the EndPointBlank library.

The version of this library, as published in mix.exs.

Functions

configure(opts)

Configures the EndPointBlank library.

Options

  • :base_url - Authorization and update endpoint base URL
  • :log_base_url - Logging endpoint base URL
  • :client_id - API credential client ID
  • :client_secret - API credential client secret
  • :app_name - Application identifier sent with every payload
  • :environment - Deployment environment (e.g. "development")
  • :application_version - App version string (e.g. a git SHA)
  • :log_mode - :direct (synchronous) or :delayed (background queue)
  • :token_ttl - Optional access-token TTL in seconds
  • :version_finder - Optional 1-arity function for custom version detection

Example

EndPointBlank.configure(
  base_url: "http://localhost:4001",
  log_base_url: "http://localhost:4001",
  client_id: "my-client-id",
  client_secret: "my-client-secret",
  app_name: "my-app",
  environment: "development",
  log_mode: :direct
)

version()

@spec version() :: String.t()

The version of this library, as published in mix.exs.

Read from the loaded application spec rather than restated as a module attribute here. The literal was previously duplicated between mix.exs and this module and the two never agreed: mix.exs reached 0.4.0 while this reported 0.3.2, so lib_version on every endpoint-update payload named a version that was never released. The portal answers "which customers run which SDK build" from that field.

The .app file this reads is regenerated from mix.exs on every compile, so there is no baked-in copy that can go stale, and each dependency carries its own spec — no ambiguity about whose version is read when this library is consumed as a dep.