lognexis 1.0.0 → 1.0.1
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.
- checksums.yaml +4 -4
- data/README.md +24 -8
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: aa370c5685ab8908882c609bcf059af8b2bcfc446a39e76f6d90f36434abcf47
|
|
4
|
+
data.tar.gz: fdfab8e39d46fd2f66a7ac3dc7e2e0732460c78ca2987836ac8b16b83919b2f0
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9be2215a7d83f27d7be3265a637e469ed2eb71f16b75eee927ac3430ac6828847967a00f807649d58e49f3390998093ba926e6c1e7a1bcb80e9f5edda9d76fe4
|
|
7
|
+
data.tar.gz: 1f9797a47b757e9a66dbd3bea866dc4afed798db7dc91ceefa4fdf79d60ccd7c58d8006cadb770c616edd3d4ff858d4a41c8b47fc481fe6f628f97f23aa26c72
|
data/README.md
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
# LogNexis Ruby SDK
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The official Ruby tracking SDK for **LogNexis** — the lightweight, real-time API monitoring, analytics, and observability platform.
|
|
4
|
+
|
|
5
|
+
**Website:** [https://lognexis.online](https://lognexis.online)
|
|
6
|
+
**Documentation:** [https://lognexis.online/docs](https://lognexis.online/docs)
|
|
7
|
+
|
|
8
|
+
## What it does
|
|
9
|
+
Automatically capture API request logs, HTTP errors, latency metrics, and real-world performance without blocking your application threads. It works universally across any Rack-based framework.
|
|
4
10
|
|
|
5
11
|
## Installation
|
|
6
12
|
|
|
@@ -15,14 +21,19 @@ And then execute:
|
|
|
15
21
|
$ bundle install
|
|
16
22
|
```
|
|
17
23
|
|
|
24
|
+
Or install it yourself via:
|
|
25
|
+
```bash
|
|
26
|
+
$ gem install lognexis
|
|
27
|
+
```
|
|
28
|
+
|
|
18
29
|
## Quick Start (Ruby on Rails)
|
|
19
30
|
|
|
20
|
-
In your `config/application.rb` or inside
|
|
31
|
+
In your `config/application.rb` or inside a new initializer like `config/initializers/lognexis.rb`:
|
|
21
32
|
|
|
22
33
|
```ruby
|
|
23
34
|
require 'lognexis'
|
|
24
35
|
|
|
25
|
-
Rails.application.config.middleware.use LogNexis::RackMiddleware, api_key: "
|
|
36
|
+
Rails.application.config.middleware.use LogNexis::RackMiddleware, api_key: "YOUR_LOGNEXIS_API_KEY"
|
|
26
37
|
```
|
|
27
38
|
|
|
28
39
|
## Quick Start (Sinatra / Rack)
|
|
@@ -33,24 +44,29 @@ In your `config.ru` or main app file:
|
|
|
33
44
|
require 'sinatra'
|
|
34
45
|
require 'lognexis'
|
|
35
46
|
|
|
36
|
-
use LogNexis::RackMiddleware, api_key: "
|
|
47
|
+
use LogNexis::RackMiddleware, api_key: "YOUR_LOGNEXIS_API_KEY"
|
|
37
48
|
|
|
38
49
|
get '/' do
|
|
39
50
|
'Hello World'
|
|
40
51
|
end
|
|
41
52
|
```
|
|
42
53
|
|
|
43
|
-
## Manual Usage
|
|
54
|
+
## Manual Usage (Background Jobs / Services)
|
|
55
|
+
|
|
56
|
+
If you aren't using a web server or want to log background jobs:
|
|
44
57
|
|
|
45
58
|
```ruby
|
|
46
59
|
require 'lognexis'
|
|
47
60
|
|
|
48
|
-
client = LogNexis::Client.new("
|
|
61
|
+
client = LogNexis::Client.new("YOUR_LOGNEXIS_API_KEY")
|
|
49
62
|
|
|
50
63
|
client.capture({
|
|
51
|
-
endpoint: "/custom-job",
|
|
64
|
+
endpoint: "/custom-job/user-sync",
|
|
52
65
|
method: "POST",
|
|
53
66
|
statusCode: 200,
|
|
54
|
-
latency:
|
|
67
|
+
latency: 145.5
|
|
55
68
|
})
|
|
56
69
|
```
|
|
70
|
+
|
|
71
|
+
## How it works
|
|
72
|
+
This SDK uses Ruby's built-in `Net::HTTP` inside of a non-blocking `Thread.new` block. It operates in a completely "fire-and-forget" manner, meaning that even if the LogNexis servers were to go down, your application will NEVER crash and your API response times will NEVER be slowed down by this SDK.
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: lognexis
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.
|
|
4
|
+
version: 1.0.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Gopal562004
|
|
@@ -36,7 +36,7 @@ files:
|
|
|
36
36
|
- lib/lognexis.rb
|
|
37
37
|
- lib/lognexis/client.rb
|
|
38
38
|
- lib/lognexis/rack_middleware.rb
|
|
39
|
-
homepage: https://
|
|
39
|
+
homepage: https://lognexis.online
|
|
40
40
|
licenses:
|
|
41
41
|
- MIT
|
|
42
42
|
metadata: {}
|