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.

Sign up for GitHub

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

chore: update extractors descriptions #467

Merged
merged 2 commits into from
Jan 31, 2023
Merged

chore: update extractors descriptions #467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
005b1da
chore: fix extractor descriptions
ravisuhag Jan 31, 2023
44fea62
chore: fix console base plugin
ravisuhag Jan 31, 2023
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
2 changes: 1 addition & 1 deletion plugins/extractors/application_yaml/application_yaml.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ var info = plugins.Info{
Description: "Application metadata from YAML file",
SampleConfig: sampleConfig,
Summary: summary,
Tags: []string{"application", "file", "extractor"},
Tags: []string{"application", "file"},
}

// Extractor is the extractor instance for application YAML file.
Expand Down
5 changes: 3 additions & 2 deletions plugins/extractors/bigquery/bigquery.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package bigquery

import (
"cloud.google.com/go/datacatalog/apiv1/datacatalogpb"
"context"
_ "embed" // used to print the embedded assets
"encoding/base64"
Expand All @@ -11,6 +10,8 @@ import (
"strings"
"sync"

"cloud.google.com/go/datacatalog/apiv1/datacatalogpb"

"cloud.google.com/go/bigquery"
datacatalog "cloud.google.com/go/datacatalog/apiv1"
"github.com/odpf/meteor/models"
Expand Down Expand Up @@ -90,7 +91,7 @@ usage_period_in_day: 7`
var info = plugins.Info{
Description: "Big Query table metadata and metrics",
SampleConfig: sampleConfig,
Tags: []string{"gcp", "table", "extractor"},
Tags: []string{"gcp", "table"},
Summary: summary,
}

Expand Down
2 changes: 1 addition & 1 deletion plugins/extractors/bigtable/bigtable.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ type Config struct {
}

var info = plugins.Info{
Description: "Compressed, high-performance, proprietary data storage system.",
Description: "Compressed, high-performance, data storage system.",
Summary: summary,
Tags: []string{"gcp", "extractor"},
SampleConfig: `
Expand Down
2 changes: 1 addition & 1 deletion plugins/extractors/caramlstore/caramlstore.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ var info = plugins.Info{
Description: "CaraML store ML feature metadata",
SampleConfig: sampleConfig,
Summary: summary,
Tags: []string{"caraml", "caramlstore", "ml", "feature", "extractor"},
Tags: []string{"caraml", "ml", "feature"},
}

// Extractor manages the communication with the CaraML Store service
Expand Down
2 changes: 1 addition & 1 deletion plugins/extractors/gcs/gcs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ service_account_json: |-
}`

var info = plugins.Info{
Description: "Online file storage web service for storing and accessing data.",
Description: "Online file storage service By Google",
SampleConfig: sampleConfig,
Summary: summary,
Tags: []string{"gcp", "extractor"},
Expand Down
2 changes: 1 addition & 1 deletion plugins/extractors/http/http_extractor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ var sampleConfig = heredoc.Doc(`
`)

var info = plugins.Info{
Description: "Generic Extractor capable of using the HTTP response from an external API for constructing 0 or more assets",
Description: "Assets metadata from an external HTTP API",
SampleConfig: sampleConfig,
Summary: summary,
Tags: []string{"http", "extractor"},
Expand Down
2 changes: 1 addition & 1 deletion plugins/extractors/merlin/merlin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ var info = plugins.Info{
Description: "Merlin ML models metadata",
SampleConfig: sampleConfig,
Summary: summary,
Tags: []string{"merlin", "ml", "model", "extractor"},
Tags: []string{"merlin", "ml", "model"},
}

// Extractor manages the communication with the Merlin service.
Expand Down
2 changes: 1 addition & 1 deletion plugins/extractors/optimus/optimus.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ var info = plugins.Info{
Description: "Optimus' jobs metadata",
SampleConfig: sampleConfig,
Summary: summary,
Tags: []string{"optimus", "bigquery", "job", "extractor"},
Tags: []string{"optimus", "bigquery"},
}

// Extractor manages the communication with the bigquery service
Expand Down
2 changes: 1 addition & 1 deletion plugins/processors/script/tengo_script.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ var sampleConfig = heredoc.Doc(`
`)

var info = plugins.Info{
Description: "Transform the extracted asset with the configured Tengo script",
Description: "Transform the asset with a Tengo script",
SampleConfig: sampleConfig,
Summary: summary,
Tags: []string{"processor", "transform", "script"},
Expand Down
6 changes: 2 additions & 4 deletions plugins/sinks/console/sink.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ var summary string

var info = plugins.Info{
Description: "Log to standard output",
SampleConfig: "",
Summary: summary,
Tags: []string{"log", "sink"},
SampleConfig: "",
}

type Sink struct {
Expand Down Expand Up @@ -67,9 +67,7 @@ func (s *Sink) process(asset *assetsv1beta2.Asset) error {

func init() {
if err := registry.Sinks.Register("console", func() plugins.Syncer {
return &Sink{
logger: plugins.GetLog(),
}
return New(plugins.GetLog())
}); err != nil {
panic(err)
}
Expand Down
6 changes: 3 additions & 3 deletions plugins/sinks/file/file.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ type Config struct {
}

var info = plugins.Info{
Description: "save output to a file",
Description: "Save output to a file",
Summary: summary,
Tags: []string{"file", "json", "yaml", "sink"},
SampleConfig: heredoc.Doc(`
Expand All @@ -53,7 +53,7 @@ func New(logger log.Logger) plugins.Syncer {
return s
}

func (s *Sink) Init(ctx context.Context, config plugins.Config) (error) {
func (s *Sink) Init(ctx context.Context, config plugins.Config) error {
if err := s.BasePlugin.Init(ctx, config); err != nil {
return err
}
Expand Down Expand Up @@ -121,7 +121,7 @@ func (s *Sink) yamlOut(data []*assetsv1beta2.Asset) error {
if err != nil {
return err
}

return s.writeBytes(ymlByte)
}

Expand Down