Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add multiple config for datasource #361

Merged
merged 5 commits into from
Apr 22, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
* Make README.md file a required file for a package. [#287](https://github.com/elastic/integrations-registry/pull/287)
* Add stream fields to each dataset [#296](https://github.com/elastic/integrations-registry/pull/296)
* Add `all` query param to return all packages. By default is set false. [#301](https://github.com/elastic/integrations-registry/pull/301)
* Add `multiple` config for datasource. By default true. [#](https://github.com/elastic/integrations-registry/pull/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: missing reference to PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

* Add `removable` flag to package manifest. Default is true. [#359](https://github.com/elastic/integrations-registry/pull/359)

### Deprecated
Expand Down
2 changes: 1 addition & 1 deletion docs/api/categories.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{
"id": "logs",
"title": "Logs",
"count": 3
"count": 4
},
{
"id": "metrics",
Expand Down
3 changes: 2 additions & 1 deletion docs/api/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,8 @@
}
]
}
]
],
"multiple": true
}
],
"download": "/epr/example/example-1.0.0.tar.gz",
Expand Down
9 changes: 9 additions & 0 deletions docs/api/search-all.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,14 @@
"title": "Foo",
"type": "solution",
"version": "1.0.0"
},
{
"description": "Tests that multiple can be set to false",
"download": "/epr/multiple-false/multiple-false-0.0.1.tar.gz",
"name": "multiple-false",
"path": "/package/multiple-false/0.0.1",
"title": "Multiple false",
"type": "integration",
"version": "0.0.1"
}
]
9 changes: 9 additions & 0 deletions docs/api/search-category-logs.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,14 @@
"title": "Example Integration",
"type": "integration",
"version": "1.0.0"
},
{
"description": "Tests that multiple can be set to false",
"download": "/epr/multiple-false/multiple-false-0.0.1.tar.gz",
"name": "multiple-false",
"path": "/package/multiple-false/0.0.1",
"title": "Multiple false",
"type": "integration",
"version": "0.0.1"
}
]
9 changes: 9 additions & 0 deletions docs/api/search-kibana652.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,14 @@
"title": "Example",
"type": "integration",
"version": "0.0.2"
},
{
"description": "Tests that multiple can be set to false",
"download": "/epr/multiple-false/multiple-false-0.0.1.tar.gz",
"name": "multiple-false",
"path": "/package/multiple-false/0.0.1",
"title": "Multiple false",
"type": "integration",
"version": "0.0.1"
}
]
9 changes: 9 additions & 0 deletions docs/api/search-kibana721.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,14 @@
"title": "Foo",
"type": "solution",
"version": "1.0.0"
},
{
"description": "Tests that multiple can be set to false",
"download": "/epr/multiple-false/multiple-false-0.0.1.tar.gz",
"name": "multiple-false",
"path": "/package/multiple-false/0.0.1",
"title": "Multiple false",
"type": "integration",
"version": "0.0.1"
}
]
9 changes: 9 additions & 0 deletions docs/api/search-package-internal.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,14 @@
"title": "Internal",
"type": "integration",
"version": "1.2.0"
},
{
"description": "Tests that multiple can be set to false",
"download": "/epr/multiple-false/multiple-false-0.0.1.tar.gz",
"name": "multiple-false",
"path": "/package/multiple-false/0.0.1",
"title": "Multiple false",
"type": "integration",
"version": "0.0.1"
}
]
9 changes: 9 additions & 0 deletions docs/api/search.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,14 @@
"title": "Foo",
"type": "solution",
"version": "1.0.0"
},
{
"description": "Tests that multiple can be set to false",
"download": "/epr/multiple-false/multiple-false-0.0.1.tar.gz",
"name": "multiple-false",
"path": "/package/multiple-false/0.0.1",
"title": "Multiple false",
"type": "integration",
"version": "0.0.1"
}
]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
foo: bar
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"description": "Pipeline for normalizing envoyproxy logs",
"processors": []
}
13 changes: 13 additions & 0 deletions testdata/package/multiple-false-0.0.1/dataset/foo/manifest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
title: Foo

# Needs to describe the type of this input
type: logs

streams:
- input: logs
vars:
- name: paths
required: true
description: Path to log files to be collected
type: text
multi: true
Empty file.
18 changes: 18 additions & 0 deletions testdata/package/multiple-false-0.0.1/manifest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
format_version: 1.0.0

name: multiple-false
description: Tests that multiple can be set to false
version: 0.0.1
title: Multiple false
categories: ["logs"]
type: integration


datasources:
- name: logs
title: Logs datasource
description: Datasource for your log files.
inputs:
- type: logs
multiple: false

3 changes: 2 additions & 1 deletion testdata/public/package/datasources/1.0.0/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,8 @@
{
"type": "syslog"
}
]
],
"multiple": true
}
],
"download": "/epr/datasources/datasources-1.0.0.tar.gz",
Expand Down
3 changes: 2 additions & 1 deletion testdata/public/package/default-pipeline/0.0.2/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@
}
]
}
]
],
"multiple": true
}
],
"download": "/epr/default-pipeline/default-pipeline-0.0.2.tar.gz",
Expand Down
3 changes: 2 additions & 1 deletion testdata/public/package/example/1.0.0/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,8 @@
}
]
}
]
],
"multiple": true
}
],
"download": "/epr/example/example-1.0.0.tar.gz",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
foo: bar
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"description": "Pipeline for normalizing envoyproxy logs",
"processors": []
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

- name: stream.type
type: constant_keyword
description: >
Stream type
- name: stream.dataset
type: constant_keyword
description: >
Stream dataset.
- name: stream.namespace
type: constant_keyword
description: >
Stream namespace.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
title: Foo

# Needs to describe the type of this input
type: logs

streams:
- input: logs
vars:
- name: paths
required: true
description: Path to log files to be collected
type: text
multi: true
Empty file.
83 changes: 83 additions & 0 deletions testdata/public/package/multiple-false/0.0.1/index.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
{
"format_version": "1.0.0",
"name": "multiple-false",
"title": "Multiple false",
"version": "0.0.1",
"readme": "/package/multiple-false/0.0.1/docs/README.md",
"license": "basic",
"description": "Tests that multiple can be set to false",
"type": "integration",
"categories": [
"logs"
],
"requirement": {
"kibana": {},
"elasticsearch": {}
},
"assets": [
"/package/multiple-false/0.0.1/manifest.yml",
"/package/multiple-false/0.0.1/docs/README.md",
"/package/multiple-false/0.0.1/dataset/foo/manifest.yml",
"/package/multiple-false/0.0.1/dataset/foo/fields/stream.yml",
"/package/multiple-false/0.0.1/dataset/foo/agent/stream/stream.yml",
"/package/multiple-false/0.0.1/dataset/foo/elasticsearch/ingest-pipeline/default.json"
],
"datasets": [
{
"id": "multiple-false.foo",
"title": "Foo",
"release": "beta",
"type": "logs",
"ingest_pipeline": "default",
"streams": [
{
"input": "logs",
"vars": [
{
"name": "paths",
"type": "text",
"description": "Path to log files to be collected",
"multi": true,
"required": true,
"show_user": false
}
]
}
],
"package": "multiple-false",
"path": "foo"
}
],
"datasources": [
{
"name": "logs",
"title": "Logs datasource",
"description": "Datasource for your log files.",
"inputs": [
{
"type": "logs",
"streams": [
{
"input": "logs",
"vars": [
{
"name": "paths",
"type": "text",
"description": "Path to log files to be collected",
"multi": true,
"required": true,
"show_user": false
}
],
"dataset": "multiple-false.foo",
"template": "foo: bar\n"
}
]
}
],
"multiple": false
}
],
"download": "/epr/multiple-false/multiple-false-0.0.1.tar.gz",
"path": "/package/multiple-false/0.0.1"
}
18 changes: 18 additions & 0 deletions testdata/public/package/multiple-false/0.0.1/manifest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
format_version: 1.0.0

name: multiple-false
description: Tests that multiple can be set to false
version: 0.0.1
title: Multiple false
categories: ["logs"]
type: integration


datasources:
- name: logs
title: Logs datasource
description: Datasource for your log files.
inputs:
- type: logs
multiple: false

8 changes: 8 additions & 0 deletions util/package.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ type Datasource struct {
Description string `config:"description" json:"description" validate:"required"`
Solution string `config:"solution" json:"solution,omitempty" yaml:"solution,omitempty"`
Inputs []Input `config:"inputs" json:"inputs"`
Multiple *bool `config:"multiple" json:"multiple" yaml:"multiple"`
}

type Requirement struct {
Expand Down Expand Up @@ -108,6 +109,13 @@ func NewPackage(basePath string) (*Package, error) {
return nil, err
}

// Default for the multiple flags is true.
trueValue := true
for i, _ := range p.Datasources {
if p.Datasources[i].Multiple == nil {
p.Datasources[i].Multiple = &trueValue
}
}
if p.Type == "" {
p.Type = defaultType
}
Expand Down