Packages
timber
1.1.6
3.1.2
3.1.1
3.1.0
3.0.0
3.0.0-alpha.3
3.0.0-alpha.2
3.0.0-alpha.1
2.8.4
2.8.3
2.8.2
2.8.1
2.8.0
2.7.0
2.6.1
2.6.0
2.5.6
2.5.5
2.5.4
2.5.3
2.5.2
2.5.1
2.5.0
2.4.5
2.4.4
2.4.3
2.4.2
2.4.1
2.4.0
2.3.4
2.3.3
2.3.1
2.3.0
2.2.1
2.2.0
2.1.8
2.1.7
2.1.6
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.2
2.0.1
2.0.0
2.0.0-rc7
2.0.0-rc6
2.0.0-rc5
2.0.0-rc4
2.0.0-rc3
2.0.0-rc2
2.0.0-rc1
1.1.18
1.1.17
1.1.16
1.1.15
1.1.14
1.1.13
1.1.12
1.1.11
1.1.10
1.1.9
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.16
1.0.15
1.0.14
1.0.13
1.0.12
1.0.11
1.0.10
1.0.9
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.3.2
0.3.1
0.3.0
0.2.3
0.2.2
0.2.1
0.2.0
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
🌲 Great Elixir Logging Made Easy. Official Timber.io Integration.
Current section
Files
Jump to
Current section
Files
lib/mix/tasks/timber/install/messages.ex
defmodule Mix.Tasks.Timber.Install.Messages do
@app_url "https://app.timber.io"
@docs_url "https://timber.io/docs"
@repo_url "https://github.com/timberio/timber-elixir"
@support_email "support@timber.io"
@twitter_handle "@timberdotio"
@website_url "https://timber.io"
def action_starting(message) do
message_length = String.length(message)
success_length = String.length(success())
difference = 80 - success_length - message_length
if difference > 0 do
message <> String.duplicate(".", difference)
else
message
end
end
def finish() do
"""
#{separator()}
Done! Commit these changes and deploy. 🎉
* Timber URL: https://app.timber.io
* Get ✨ 250mb✨ for tweeting your experience to #{@twitter_handle}
* Get ✨ 100mb✨ for starring our repo: #{@repo_url}
* Get ✨ 50mb✨ for following #{@twitter_handle} on twitter
(Your account will be credited within 2-3 business days.
If you do not notice a credit please contact us: #{@support_email})
"""
end
def forgot_key do
"""
Uh oh! You forgot to include your API key. Please specify it via:
mix timber.install timber-application-api-key
#{obtain_key_instructions()}
#{get_help()}
"""
end
def get_help do
"""
Still stuck?
* Shoot us an email: #{@support_email}
* Or, file an issue: #{@repo_url}/issues
"""
end
def header do
"""
🌲 Timber installation
#{separator()}
Website: #{@website_url}
Documentation: #{@docs_url}
Support: #{@support_email}
#{separator()}
"""
end
def heroku_drain_instructions(heroku_drain_url) do
"""
#{separator()}
Now we need to send your logs to the Timber service.
Please run this command in a separate terminal and return back here when complete:
heroku drains:add #{heroku_drain_url}
"""
end
def intro do
"""
This installer will walk you through setting up Timber in your application.
At the end we'll make sure logs are flowing properly.
Grab your axe!
"""
end
def obtain_key_instructions do
"""
You can obtain your key by adding an application in #{@app_url},
or by clicking 'edit' next to your application.
"""
end
def outgoing_http_instructions do
"""
Great! Timber can track all of your outgoing HTTP requests and
responses. You'll have access to the body contents, headers,
and all other request details. Offering all of the data you need
to solve an issue when it arises.
To install, please add this code wherever you issue HTTP requests:
Timber.Events.HTTPClient.log(method, headers, url, :stripe, fn ->
:hackney.request(method, path) # just an example, use any HTTP client you want
end)
time_ms = Timber.duration_ms(timer)
{event, message} =
HTTPClientResponseEvent.new_with_message(headers: headers, status: status, time_ms: time_ms)
level = response_logger_level(status, time_ms)
Logger.log(level, message, event: event)
%Timber.Events.HTTPClientRequest{id: id, name: name, email: email}
"""
end
def separator do
"--------------------------------------------------------------------------------"
end
def success do
"✓ Success!"
end
def user_context_instructions do
"""
Great! Timber can add user context to your logs, allowing you to search
and tail logs for specific users. To install this, please add this
code wherever you authenticate your user. Typically in a plug:
%Timber.Contexts.UserContext{id: id, name: name, email: email}
|> Timber.add_context()
"""
end
end