Yeller Documentation

Welcome to Yeller's documentation. Here you'll find guides on how to get Yeller installed in your app.

Need help?

I'm always happy to help out with code or any other questions.

Email me :

If you want to pair on getting Yeller setup on your project, or chat about how to use it most effectively, that's available as well, just hit me up via email.

Quick Start

If you've integrated Yeller before, or just want a cheat sheet to integrating the client libraries, see below.

Leiningen:

[yeller-clojure-client "1.2.1"]

Then use the ring middleware


(require 'yeller.clojure.ring)

(yeller.clojure.ring/wrap-ring
  my-app
  {:token "YOUR TOKEN HERE"
   :environment "production"})

Leiningen:

[yeller-clojure-client "1.0.0"]

Then use the ring middleware


;; Use our clojure ring middleware

(require 'yeller.clojure.ring)

(yeller.clojure.ring/wrap-ring
  my-app
  {:token "YOUR TOKEN HERE"
   :environment "production"})

Add the gem to your Gemfile

gem "yeller_ruby"

Then configure and use a client


yeller_client = Yeller.client do |client|
  client.token = "YOUR_TOKEN_HERE"
end

# record an exception
begin
  # your code here
rescue StandardError => e
  yeller_client.report(e)
end

Or use our rack middleware


Yeller::Rack.configure do |config|
  config.token = 'YOUR API KEY HERE'
end
use Yeller::Rack

Add the gem to your Gemfile

gem "yeller_ruby"

Then use the Rails integration


# in config/initializers/yeller.rb

Yeller::Rails.configure do |config|
  config.token = 'YOUR_API_KEY_HERE'
end

Grab the dependency from Maven:


<dependency>
  <groupId>yeller-java-api</groupId>
  <artifactId>yeller-java-api</artifactId>
  <version>0.2.0</version>
</dependency>


// make a client
YellerClient yellerClient = new YellerClient('YOUR_API_KEY_HERE');

//Report your own exception
try {
    // Your code here
} catch (Throwable t) {
    yellerClient.report(t);
    throw t;
}

Load the script from the CDN, placing it in <head> above all other scripts (if you want to catch errors when loading them)


<script src="//js-yellerapp.a.ssl.fastly.net/yeller.js">


<script>
Yeller.configure({
  token: 'YOUR_API_TOKEN_HERE'
});
try {
  // your code here
catch(err) {
  Yeller.report(err,
    { custom_data: {user_id: 123}});
}
</script>

Import the library from github:


import (
    "github.com/yeller/yeller-golang"
)

Then connect to a client and start sending errors


// Start yeller in a specific deployment environment
yeller.StartEnv("YOUR_API_KEY", "production")

file, err := os.Open("filename.ext")
if err != nil {
    // Notify the error by itself, with additional information
    // about what was going on when the error happened.
    info := make(map[string]interface{})
    info["filename"] = "filename.ext"
    yeller.NotifyInfo(err, info)
}

Import the library from hackage:


yeller >= 0.1.0.4

Then connect to a client and start sending errors


import Network.Yeller

yellerClient <- client (defaultClientSettings { clientSettingsToken = YellerToken "YOUR_TOKEN_HERE" })

sendError yellerClient myError emptyExtraErrorInfo

Install the library via npm


npm install yeller_node


var yeller = require('./yeller_node')
var yellerClient = yeller.client({token: 'YOUR_API_TOKEN_HERE'})
try {
  // your code here
} catch (e) {
  yellerClient.report(e, {customData: {user: {id: user.id}}});
}

Clients

Yeller Documentation

Need help?

Quick Start