trakerr_client 1.0.0r
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +5 -0
- data/README.md +148 -0
- data/generated/.gitignore +50 -0
- data/generated/.rspec +2 -0
- data/generated/.swagger-codegen-ignore +23 -0
- data/generated/LICENSE +201 -0
- data/generated/README.md +97 -0
- data/generated/docs/AppEvent.md +30 -0
- data/generated/docs/CustomData.md +9 -0
- data/generated/docs/CustomDoubleData.md +17 -0
- data/generated/docs/CustomStringData.md +17 -0
- data/generated/docs/Error.md +10 -0
- data/generated/docs/EventsApi.md +55 -0
- data/generated/docs/InnerStackTrace.md +10 -0
- data/generated/docs/StackTraceLine.md +10 -0
- data/generated/docs/StackTraceLines.md +7 -0
- data/generated/docs/Stacktrace.md +7 -0
- data/generated/git_push.sh +67 -0
- data/generated/lib/trakerr_client/api/events_api.rb +90 -0
- data/generated/lib/trakerr_client/api_client.rb +378 -0
- data/generated/lib/trakerr_client/api_error.rb +47 -0
- data/generated/lib/trakerr_client/configuration.rb +207 -0
- data/generated/lib/trakerr_client/models/app_event.rb +454 -0
- data/generated/lib/trakerr_client/models/custom_data.rb +208 -0
- data/generated/lib/trakerr_client/models/custom_double_data.rb +280 -0
- data/generated/lib/trakerr_client/models/custom_string_data.rb +280 -0
- data/generated/lib/trakerr_client/models/error.rb +217 -0
- data/generated/lib/trakerr_client/models/inner_stack_trace.rb +217 -0
- data/generated/lib/trakerr_client/models/stack_trace_line.rb +217 -0
- data/generated/lib/trakerr_client/models/stack_trace_lines.rb +190 -0
- data/generated/lib/trakerr_client/models/stacktrace.rb +190 -0
- data/generated/lib/trakerr_client/version.rb +26 -0
- data/generated/lib/trakerr_client.rb +60 -0
- data/generated/spec/api/events_api_spec.rb +58 -0
- data/generated/spec/api_client_spec.rb +237 -0
- data/generated/spec/configuration_spec.rb +53 -0
- data/generated/spec/models/app_event_spec.rb +167 -0
- data/generated/spec/models/custom_data_spec.rb +59 -0
- data/generated/spec/models/custom_double_data_spec.rb +107 -0
- data/generated/spec/models/custom_string_data_spec.rb +107 -0
- data/generated/spec/models/error_spec.rb +65 -0
- data/generated/spec/models/inner_stack_trace_spec.rb +65 -0
- data/generated/spec/models/stack_trace_line_spec.rb +65 -0
- data/generated/spec/models/stack_trace_lines_spec.rb +47 -0
- data/generated/spec/models/stacktrace_spec.rb +47 -0
- data/generated/spec/spec_helper.rb +122 -0
- data/generated/trakerr_client.gemspec +55 -0
- data/mkgem.sh +6 -0
- data/test_app.rb +40 -0
- data/trakerr/lib/event_trace_builder.rb +163 -0
- data/trakerr/lib/trakerr.rb +235 -0
- data/trakerr_client.gemspec +58 -0
- metadata +313 -0
data/README.md
ADDED
@@ -0,0 +1,148 @@
|
|
1
|
+
# trakerr_client
|
2
|
+
Get your application events and errors to Trakerr via the *Trakerr API*.
|
3
|
+
|
4
|
+
You will need your API key to send events to trakerr.
|
5
|
+
|
6
|
+
## Requirements.
|
7
|
+
|
8
|
+
Ruby 1.9.3+
|
9
|
+
and
|
10
|
+
git 2.0+
|
11
|
+
|
12
|
+
## Installation & Usage
|
13
|
+
### 1) Install git and curl
|
14
|
+
You will need git for the gem to work properly. If you do not have it installed, we recomment installing it from your package manager. You can use your package manager to install it on unix based machines. For machines using apt (ex: Ubuntu)
|
15
|
+
|
16
|
+
```bash
|
17
|
+
apt install git
|
18
|
+
```
|
19
|
+
|
20
|
+
For machines using yum (ex: centOS)
|
21
|
+
```bash
|
22
|
+
yum install git
|
23
|
+
```
|
24
|
+
|
25
|
+
For Windows, or if you aren't using a package manager, visit https://git-scm.com/ and download and install it manually. Make sure it is added to your path (open your command prompt and type git --version. If it works, you're set.)
|
26
|
+
|
27
|
+
|
28
|
+
If you are on Windows, you may also need to install curl and configure your ruby to use it. Trakerr uses typhous to actually send the exception to us. Follow the instructions on the curl website for more information and Typhous's project page to finish setup.
|
29
|
+
|
30
|
+
### 2) gem install
|
31
|
+
|
32
|
+
Install [bundler](http://bundler.io/) and then you can issue this command to get the freshest version:
|
33
|
+
```sh
|
34
|
+
gem "trakerr_client", :git => "git://github.com/trakerr-io/trakerr-ruby.git"
|
35
|
+
```
|
36
|
+
|
37
|
+
You can also install from ruby gems:
|
38
|
+
```sh
|
39
|
+
gem install trakerr_client
|
40
|
+
```
|
41
|
+
for the latest stable release.
|
42
|
+
|
43
|
+
Then import the package:
|
44
|
+
```ruby
|
45
|
+
require 'trakerr/lib/trakerr'
|
46
|
+
```
|
47
|
+
|
48
|
+
## Getting Started
|
49
|
+
|
50
|
+
Please follow the [installation procedure](#installation--usage) and you're set to add Trakerr to your project. All of these examples are included in test_app.rb.
|
51
|
+
|
52
|
+
If you would like to generate some quick sample events, you may download test_app.rb and run it from the command line like so:
|
53
|
+
```sh
|
54
|
+
ruby test_app.rb <api key here>
|
55
|
+
```
|
56
|
+
|
57
|
+
## Sending Data
|
58
|
+
Require the package:
|
59
|
+
|
60
|
+
```ruby
|
61
|
+
require 'trakerr/lib/trakerr'
|
62
|
+
```
|
63
|
+
|
64
|
+
### Option 1: Sending a default error to Trakerr
|
65
|
+
A trivial case would involve calling `SendException` for a caught exception.
|
66
|
+
```ruby
|
67
|
+
def main()
|
68
|
+
testApp = Trakerr::TrakerrClient.new("Api key here", "Application version number", "deployment type")
|
69
|
+
begin
|
70
|
+
raise ArgumentError
|
71
|
+
rescue Exception => e
|
72
|
+
testApp.SendException(e)
|
73
|
+
end
|
74
|
+
end
|
75
|
+
```
|
76
|
+
|
77
|
+
`SendExecption` may also take in a log_level and a classification, but will otherwise default all of the AppEvent properties.
|
78
|
+
|
79
|
+
### Option 2: Sending an error to Trakerr with Custom Data
|
80
|
+
If you want to populate the `AppEvent` with custom properties, you can manually create an `AppEvent` and populate it's fields. Pass it to the `SendEvent` to then send the AppEvent to Trakerr. See the `AppEvent` API for more information on it's properties.
|
81
|
+
|
82
|
+
```ruby
|
83
|
+
def main()
|
84
|
+
testApp = Trakerr::TrakerrClient.new("Api key here", "Application version number", "deployment type")
|
85
|
+
begin
|
86
|
+
raise ArgumentError
|
87
|
+
rescue Exception => e
|
88
|
+
appev = testApp.CreateAppEvent(e)
|
89
|
+
appev.event_user = "john@trakerr.io"
|
90
|
+
appev.event_session = "5"
|
91
|
+
|
92
|
+
testApp.SendEvent(appev)
|
93
|
+
end
|
94
|
+
end
|
95
|
+
```
|
96
|
+
|
97
|
+
### Option 3: Send a non-exception to Trakerr
|
98
|
+
Trakerr accepts events that aren't errors. To do so, pass false to the CreateAppEvent Exception field to not attach a stacktrace to the event (if you don't need it). Be sure to pass values in to the rest of the parameters since the default values will most likely not be useful for you!
|
99
|
+
```ruby
|
100
|
+
def main()
|
101
|
+
testApp = Trakerr::TrakerrClient.new("Api key here", "Application version number", "deployment type")
|
102
|
+
|
103
|
+
#Send a non Exception to Trakerr.
|
104
|
+
appev2 = testApp.CreateAppEvent(false, "Info", "User failed auth", "Passwords are different", "User error")
|
105
|
+
appev2.event_user = "jill@trakerr.io"
|
106
|
+
appev2.event_session = "3"
|
107
|
+
|
108
|
+
testApp.SendEvent(appev2)
|
109
|
+
end
|
110
|
+
```
|
111
|
+
|
112
|
+
## An in-depth look at TrakerrClient's properties
|
113
|
+
TrakerrClient's constructor initalizes the default values to all of TrakerrClient's properties.
|
114
|
+
|
115
|
+
```ruby
|
116
|
+
def initialize(def initialize(apiKey,
|
117
|
+
contextAppVersion = "1.0",
|
118
|
+
contextDeploymentStage = "development")
|
119
|
+
```
|
120
|
+
|
121
|
+
The contextEnvName name is intended to be used as a string identifier as to what your codebase is for; release, development, prototype. You can use it for whatever you denote as useful. The contextAppVersion is useful for a codebase version identifier, or perhaps some other useful metric for the error.
|
122
|
+
|
123
|
+
The TrakerrClient struct however has a lot of exposed properties. The benifit to setting these after you create the TrakerrClient is that AppEvent will default it's values against the TrakerClient that created it. This way if there is a value that all your AppEvents uses, and the constructor default value currently doesn't suit you; it may be easier to change it in TrakerrClient as it will become the default value for all AppEvents created after. A lot of these are populated by default value by the constructor, but you can populate them with whatever string data you want. The following table provides an in depth look at each of those.
|
124
|
+
|
125
|
+
|
126
|
+
Name | Type | Description | Notes
|
127
|
+
------------ | ------------- | ------------- | -------------
|
128
|
+
**api_key** | **str** | API key generated to identfy the application |
|
129
|
+
**context_app_version** | **str** | (optional) application version information | [optional if passed `None`]
|
130
|
+
**context_env_name** | **str** | (optional) one of 'development','staging','production' or a custom string | [optional if passed `None`] Default Value: "develoment"
|
131
|
+
**context_env_version** | **str** | (optional) version of environment | [optional if passed `None`] Default Value: Interpreter type(ie. cpython, ironpy) and python version (ie. 2.7.8)
|
132
|
+
**context_env_hostname** | **str** | (optional) hostname or ID of environment | [optional if passed `None`] Default value: Name of the node the program is currently run on.
|
133
|
+
**context_app_os** | **str** | (optional) OS the application is running on | [optional if passed `None`] Default value: OS name (ie. Windows, MacOS) + Release (ie. 7, 8, 10, X)
|
134
|
+
**context_app_os_version** | **str** | (optional) OS version the application is running on | [optional if passed `None`] Default value: OS provided version number
|
135
|
+
**context_data_center** | **str** | (optional) Data center the application is running on or connected to | [optional if passed `None`]
|
136
|
+
**context_data_center_region** | **str** | (optional) Data center region | [optional if passed `None`]
|
137
|
+
**context_app_browser** | **str** | (optional) browser name if running in a browser (eg. Chrome) | [optional] For web frameworks
|
138
|
+
**context_app_browser_version** | **str** | (optional) browser version if running in a browser | [optional] For web frameworks
|
139
|
+
**url_path** | **str** | message containing details of the event or error |
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
## Documentation For Models
|
144
|
+
|
145
|
+
- [AppEvent](https://github.com/trakerr-io/trakerr-python/blob/master/generated/docs/AppEvent.md)
|
146
|
+
|
147
|
+
## Author
|
148
|
+
[RM](https://github.com/RMSD)
|
@@ -0,0 +1,50 @@
|
|
1
|
+
# Generated by: https://github.com/swagger-api/swagger-codegen.git
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
*.gem
|
16
|
+
*.rbc
|
17
|
+
/.config
|
18
|
+
/coverage/
|
19
|
+
/InstalledFiles
|
20
|
+
/pkg/
|
21
|
+
/spec/reports/
|
22
|
+
/spec/examples.txt
|
23
|
+
/test/tmp/
|
24
|
+
/test/version_tmp/
|
25
|
+
/tmp/
|
26
|
+
|
27
|
+
## Specific to RubyMotion:
|
28
|
+
.dat*
|
29
|
+
.repl_history
|
30
|
+
build/
|
31
|
+
|
32
|
+
## Documentation cache and generated files:
|
33
|
+
/.yardoc/
|
34
|
+
/_yardoc/
|
35
|
+
/doc/
|
36
|
+
/rdoc/
|
37
|
+
|
38
|
+
## Environment normalization:
|
39
|
+
/.bundle/
|
40
|
+
/vendor/bundle
|
41
|
+
/lib/bundler/man/
|
42
|
+
|
43
|
+
# for a library or gem, you might want to ignore these files since the code is
|
44
|
+
# intended to run in multiple environments; otherwise, check them in:
|
45
|
+
# Gemfile.lock
|
46
|
+
# .ruby-version
|
47
|
+
# .ruby-gemset
|
48
|
+
|
49
|
+
# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
|
50
|
+
.rvmrc
|
data/generated/.rspec
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# Swagger Codegen Ignore
|
2
|
+
# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
|
3
|
+
|
4
|
+
# Use this file to prevent files from being overwritten by the generator.
|
5
|
+
# The patterns follow closely to .gitignore or .dockerignore.
|
6
|
+
|
7
|
+
# As an example, the C# client generator defines ApiClient.cs.
|
8
|
+
# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
|
9
|
+
#ApiClient.cs
|
10
|
+
|
11
|
+
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
12
|
+
#foo/*/qux
|
13
|
+
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
14
|
+
|
15
|
+
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
16
|
+
#foo/**/qux
|
17
|
+
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
18
|
+
|
19
|
+
# You can also negate patterns with an exclamation (!).
|
20
|
+
# For example, you can ignore all files in a docs folder with the file extension .md:
|
21
|
+
#docs/*.md
|
22
|
+
# Then explicitly reverse the ignore rule for a single file:
|
23
|
+
#!docs/README.md
|
data/generated/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/generated/README.md
ADDED
@@ -0,0 +1,97 @@
|
|
1
|
+
# trakerr_client
|
2
|
+
|
3
|
+
Trakerr - the Ruby gem for the Trakerr API
|
4
|
+
|
5
|
+
Get your application events and errors to Trakerr via the *Trakerr API*.
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
|
+
|
9
|
+
- API version: 1.0.0
|
10
|
+
- Package version: 1.0.0
|
11
|
+
- Build date: 2017-03-13T17:18:49.200-07:00
|
12
|
+
- Build package: class io.swagger.codegen.languages.RubyClientCodegen
|
13
|
+
|
14
|
+
## Installation
|
15
|
+
|
16
|
+
### Build a gem
|
17
|
+
|
18
|
+
To build the Ruby code into a gem:
|
19
|
+
|
20
|
+
```shell
|
21
|
+
gem build trakerr_client.gemspec
|
22
|
+
```
|
23
|
+
|
24
|
+
Then either install the gem locally:
|
25
|
+
|
26
|
+
```shell
|
27
|
+
gem install ./trakerr_client-1.0.0.gem
|
28
|
+
```
|
29
|
+
(for development, run `gem install --dev ./trakerr_client-1.0.0.gem` to install the development dependencies)
|
30
|
+
|
31
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
|
+
|
33
|
+
Finally add this to the Gemfile:
|
34
|
+
|
35
|
+
gem 'trakerr_client', '~> 1.0.0'
|
36
|
+
|
37
|
+
### Install from Git
|
38
|
+
|
39
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
40
|
+
|
41
|
+
gem 'trakerr_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
42
|
+
|
43
|
+
### Include the Ruby code directly
|
44
|
+
|
45
|
+
Include the Ruby code directly using `-I` as follows:
|
46
|
+
|
47
|
+
```shell
|
48
|
+
ruby -Ilib script.rb
|
49
|
+
```
|
50
|
+
|
51
|
+
## Getting Started
|
52
|
+
|
53
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
54
|
+
```ruby
|
55
|
+
# Load the gem
|
56
|
+
require 'trakerr_client'
|
57
|
+
|
58
|
+
api_instance = Trakerr::EventsApi.new
|
59
|
+
|
60
|
+
data = Trakerr::AppEvent.new # AppEvent | Event to submit
|
61
|
+
|
62
|
+
|
63
|
+
begin
|
64
|
+
#Submit an application event or error to Trakerr
|
65
|
+
api_instance.events_post(data)
|
66
|
+
rescue Trakerr::ApiError => e
|
67
|
+
puts "Exception when calling EventsApi->events_post: #{e}"
|
68
|
+
end
|
69
|
+
|
70
|
+
```
|
71
|
+
|
72
|
+
## Documentation for API Endpoints
|
73
|
+
|
74
|
+
All URIs are relative to *https://www.trakerr.io/api/v1*
|
75
|
+
|
76
|
+
Class | Method | HTTP request | Description
|
77
|
+
------------ | ------------- | ------------- | -------------
|
78
|
+
*Trakerr::EventsApi* | [**events_post**](docs/EventsApi.md#events_post) | **POST** /events | Submit an application event or error to Trakerr
|
79
|
+
|
80
|
+
|
81
|
+
## Documentation for Models
|
82
|
+
|
83
|
+
- [Trakerr::AppEvent](docs/AppEvent.md)
|
84
|
+
- [Trakerr::CustomData](docs/CustomData.md)
|
85
|
+
- [Trakerr::CustomDoubleData](docs/CustomDoubleData.md)
|
86
|
+
- [Trakerr::CustomStringData](docs/CustomStringData.md)
|
87
|
+
- [Trakerr::Error](docs/Error.md)
|
88
|
+
- [Trakerr::InnerStackTrace](docs/InnerStackTrace.md)
|
89
|
+
- [Trakerr::StackTraceLine](docs/StackTraceLine.md)
|
90
|
+
- [Trakerr::StackTraceLines](docs/StackTraceLines.md)
|
91
|
+
- [Trakerr::Stacktrace](docs/Stacktrace.md)
|
92
|
+
|
93
|
+
|
94
|
+
## Documentation for Authorization
|
95
|
+
|
96
|
+
All endpoints do not require authorization.
|
97
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# Trakerr::AppEvent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**api_key** | **String** | API key generated for the application |
|
7
|
+
**log_level** | **String** | (optional) Logging level, one of 'debug','info','warning','error', 'fatal', defaults to 'error' | [optional]
|
8
|
+
**classification** | **String** | (optional) one of 'error' or a custom string for non-errors, defaults to 'error' |
|
9
|
+
**event_type** | **String** | type of the event or error (eg. NullPointerException) |
|
10
|
+
**event_message** | **String** | message containing details of the event or error |
|
11
|
+
**event_time** | **Integer** | (optional) event time in ms since epoch | [optional]
|
12
|
+
**event_stacktrace** | [**Stacktrace**](Stacktrace.md) | | [optional]
|
13
|
+
**event_user** | **String** | (optional) event user identifying a user | [optional]
|
14
|
+
**event_session** | **String** | (optional) session identification | [optional]
|
15
|
+
**context_app_version** | **String** | (optional) application version information | [optional]
|
16
|
+
**deployment_stage** | **String** | (optional) deployment stage, one of 'development','staging','production' or a custom string | [optional]
|
17
|
+
**context_env_name** | **String** | (optional) environment name (like 'cpython' or 'ironpython' etc.) | [optional]
|
18
|
+
**context_env_language** | **String** | (optional) language (like 'python' or 'c#' etc.) | [optional]
|
19
|
+
**context_env_version** | **String** | (optional) version of environment | [optional]
|
20
|
+
**context_env_hostname** | **String** | (optional) hostname or ID of environment | [optional]
|
21
|
+
**context_app_browser** | **String** | (optional) browser name if running in a browser (eg. Chrome) | [optional]
|
22
|
+
**context_app_browser_version** | **String** | (optional) browser version if running in a browser | [optional]
|
23
|
+
**context_app_os** | **String** | (optional) OS the application is running on | [optional]
|
24
|
+
**context_app_os_version** | **String** | (optional) OS version the application is running on | [optional]
|
25
|
+
**context_data_center** | **String** | (optional) Data center the application is running on or connected to | [optional]
|
26
|
+
**context_data_center_region** | **String** | (optional) Data center region | [optional]
|
27
|
+
**custom_properties** | [**CustomData**](CustomData.md) | | [optional]
|
28
|
+
**custom_segments** | [**CustomData**](CustomData.md) | | [optional]
|
29
|
+
|
30
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Trakerr::CustomData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**string_data** | [**CustomStringData**](CustomStringData.md) | | [optional]
|
7
|
+
**double_data** | [**CustomDoubleData**](CustomDoubleData.md) | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# Trakerr::CustomDoubleData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**custom_data1** | **Float** | | [optional]
|
7
|
+
**custom_data2** | **Float** | | [optional]
|
8
|
+
**custom_data3** | **Float** | | [optional]
|
9
|
+
**custom_data4** | **Float** | | [optional]
|
10
|
+
**custom_data5** | **Float** | | [optional]
|
11
|
+
**custom_data6** | **Float** | | [optional]
|
12
|
+
**custom_data7** | **Float** | | [optional]
|
13
|
+
**custom_data8** | **Float** | | [optional]
|
14
|
+
**custom_data9** | **Float** | | [optional]
|
15
|
+
**custom_data10** | **Float** | | [optional]
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# Trakerr::CustomStringData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**custom_data1** | **String** | | [optional]
|
7
|
+
**custom_data2** | **String** | | [optional]
|
8
|
+
**custom_data3** | **String** | | [optional]
|
9
|
+
**custom_data4** | **String** | | [optional]
|
10
|
+
**custom_data5** | **String** | | [optional]
|
11
|
+
**custom_data6** | **String** | | [optional]
|
12
|
+
**custom_data7** | **String** | | [optional]
|
13
|
+
**custom_data8** | **String** | | [optional]
|
14
|
+
**custom_data9** | **String** | | [optional]
|
15
|
+
**custom_data10** | **String** | | [optional]
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Trakerr::Error
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**code** | **Integer** | | [optional]
|
7
|
+
**message** | **String** | | [optional]
|
8
|
+
**fields** | **String** | | [optional]
|
9
|
+
|
10
|
+
|