atsd 1.0.9 → 1.0.10
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +20 -20
- data/atsd.gemspec +1 -1
- data/lib/atsd/version.rb +1 -1
- metadata +5 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b0e89bd60ef6cebc62ea916e081c3a8c656ffe63
|
4
|
+
data.tar.gz: 3ac82ee116c326a1b4654804c1755a2eb4c32c4c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 555ff0f339e534b1a3964f5d86dace6c062f6b338c344530992bf81cb2c07f7b1028978274d2c8912974c91b2f9b14e633e736d0c1600b6755ad35467751c803
|
7
|
+
data.tar.gz: aae4d446164fd7c1e847adc972d78f6271a657c360f49bd4069917be09dc8131777d4a434bcaf6023e18dfb12c231736f227e261f8e07331308aee6732dfd3ce
|
data/README.md
CHANGED
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
The ATSD Client for Ruby enables Ruby developers
|
4
4
|
to easily read and write statistics and metadata
|
5
|
-
from Axibase Time Series Database.
|
5
|
+
from the Axibase Time Series Database.
|
6
6
|
|
7
7
|
API documentation: https://github.com/axibase/atsd-docs/blob/master/api/README.md
|
8
8
|
|
@@ -89,7 +89,7 @@ atsd = ATSD.new :url => "#{API_ENDPOINT}/api/v1",
|
|
89
89
|
### Configuration
|
90
90
|
|
91
91
|
#### Authorization
|
92
|
-
In order to use the API you need to specify `:basic_auth` option in one
|
92
|
+
In order to use the API, you need to specify the `:basic_auth` option in one
|
93
93
|
of the following ways:
|
94
94
|
|
95
95
|
- `"login:password"`
|
@@ -98,31 +98,31 @@ of the following ways:
|
|
98
98
|
#### SSL
|
99
99
|
Connecting to ATSD via SSL requires extra configuration if your ATSD instance runs on a self-signed SSL certificate.
|
100
100
|
See [Faraday Wiki](https://github.com/lostisland/faraday/wiki/Setting-up-SSL-certificates) on how to setup SSL.
|
101
|
-
As a workaround you can specify `ssl: { verify: false }` option in the client.
|
101
|
+
As a workaround you can specify the `ssl: { verify: false }` option in the client.
|
102
102
|
|
103
103
|
|
104
104
|
#### Logging
|
105
105
|
|
106
106
|
- To use a custom logger specify it in the `:logger` option.
|
107
|
-
- To use the default STDOUT logger set `:logger` option to `true`.
|
107
|
+
- To use the default STDOUT logger set the `:logger` option to `true`.
|
108
108
|
|
109
109
|
### Services
|
110
110
|
Once you instantiated the ATSD class, you can use different services.
|
111
|
-
Each service represents a particular object type in Axibase Time Series Database.
|
111
|
+
Each service represents a particular object type in the Axibase Time Series Database.
|
112
112
|
The following services are currently implemented:
|
113
113
|
|
114
|
-
- series_service
|
115
|
-
- properties_service
|
116
|
-
- messages_service
|
117
|
-
- alerts_service
|
118
|
-
- metrics_service
|
119
|
-
- entities_service
|
120
|
-
- entity_groups_service
|
114
|
+
- `series_service`
|
115
|
+
- `properties_service`
|
116
|
+
- `messages_service`
|
117
|
+
- `alerts_service`
|
118
|
+
- `metrics_service`
|
119
|
+
- `entities_service`
|
120
|
+
- `entity_groups_service`
|
121
121
|
|
122
122
|
#### Query builders
|
123
123
|
Query objects created by services provide convenient methods to build complex queries.
|
124
|
-
They support method chaining and automatically translate snake_styled properties
|
125
|
-
to CamelCase used in the API. For example, `end_time` property in ruby code becomes `endTime` in json request.
|
124
|
+
They support method chaining and automatically translate `snake_styled` properties
|
125
|
+
to CamelCase used in the API. For example, the `end_time` property in ruby code becomes `endTime` in a json request.
|
126
126
|
|
127
127
|
#### Series Service
|
128
128
|
|
@@ -176,7 +176,7 @@ query.execute
|
|
176
176
|
# :data=>[{"t"=>1428300000000, "v"=>23.57}]}]
|
177
177
|
```
|
178
178
|
|
179
|
-
Query with
|
179
|
+
Query with versions:
|
180
180
|
|
181
181
|
```ruby
|
182
182
|
query = atsd.series_service.query("sensor-2", "pressure", Time.parse("2015-11-17T12:00:00Z"), Time.parse("2015-11-17T19:00:00Z"), {:versioned => true})
|
@@ -211,7 +211,7 @@ puts output
|
|
211
211
|
2015-11-17T18:00:00Z, 17.0, 2015-11-19T11:32:35Z, gateway-1, error
|
212
212
|
```
|
213
213
|
|
214
|
-
Inserting
|
214
|
+
Inserting Series:
|
215
215
|
|
216
216
|
```ruby
|
217
217
|
s = Series.new
|
@@ -263,7 +263,7 @@ Inserting CSV data from file:
|
|
263
263
|
series_service.csv_insert('sensor-1', File.read('/path/to/data.csv'), { :user => 'beta' })
|
264
264
|
```
|
265
265
|
|
266
|
-
Retrieving series values CSV and JSON format:
|
266
|
+
Retrieving series values in CSV and JSON format:
|
267
267
|
|
268
268
|
```ruby
|
269
269
|
series_service.url_query('json','nurswgvml007','cpu_busy', :startDate => 'previous_minute', :endDate => 'now')
|
@@ -485,15 +485,15 @@ entity_groups_service.get_entities("java-loggers", :limit => 3, :timeFormat => "
|
|
485
485
|
```
|
486
486
|
|
487
487
|
### Errors
|
488
|
-
If the request wasn't completed successfully then an `ATSD::APIError` exception is raised. You can get a message and HTTP status code using the `message` and `status`
|
488
|
+
If the request wasn't completed successfully, then an `ATSD::APIError` exception is raised. You can get a message and HTTP status code using the `message` and `status`
|
489
489
|
fields.
|
490
490
|
|
491
491
|
### Low-level API Client
|
492
|
-
Gem also provides an `ATSD::Client` class. It is a simple API wrapper
|
492
|
+
Gem also provides an `ATSD::Client` class. It is a simple API wrapper,
|
493
493
|
which uses [Faraday](https://github.com/lostisland/faraday) to handle HTTP-related routines.
|
494
494
|
All services are built on top of it.
|
495
495
|
|
496
|
-
You can access `Faraday::Connection` object using the `connection` field of the client if necessary.
|
496
|
+
You can access the `Faraday::Connection` object using the `connection` field of the client if necessary.
|
497
497
|
|
498
498
|
## Development
|
499
499
|
|
data/atsd.gemspec
CHANGED
@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
|
|
24
24
|
spec.add_development_dependency 'pry', '~> 0.10'
|
25
25
|
spec.add_development_dependency 'rspec', '~> 3.2'
|
26
26
|
spec.add_development_dependency 'vcr', '~> 2.9'
|
27
|
-
spec.add_development_dependency 'yard', '~> 0.
|
27
|
+
spec.add_development_dependency 'yard', '~> 0.9.11'
|
28
28
|
spec.add_development_dependency 'redcarpet'
|
29
29
|
spec.add_development_dependency 'geminabox'
|
30
30
|
spec.add_development_dependency 'multi_json'
|
data/lib/atsd/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: atsd
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.10
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Axibase Corporation
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2017-12-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|
@@ -86,14 +86,14 @@ dependencies:
|
|
86
86
|
requirements:
|
87
87
|
- - "~>"
|
88
88
|
- !ruby/object:Gem::Version
|
89
|
-
version:
|
89
|
+
version: 0.9.11
|
90
90
|
type: :development
|
91
91
|
prerelease: false
|
92
92
|
version_requirements: !ruby/object:Gem::Requirement
|
93
93
|
requirements:
|
94
94
|
- - "~>"
|
95
95
|
- !ruby/object:Gem::Version
|
96
|
-
version:
|
96
|
+
version: 0.9.11
|
97
97
|
- !ruby/object:Gem::Dependency
|
98
98
|
name: redcarpet
|
99
99
|
requirement: !ruby/object:Gem::Requirement
|
@@ -259,9 +259,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
259
259
|
version: '0'
|
260
260
|
requirements: []
|
261
261
|
rubyforge_project:
|
262
|
-
rubygems_version: 2.6.
|
262
|
+
rubygems_version: 2.6.8
|
263
263
|
signing_key:
|
264
264
|
specification_version: 4
|
265
265
|
summary: Axibase Time Series Database Client for Ruby.
|
266
266
|
test_files: []
|
267
|
-
has_rdoc:
|