Skip to content

Add synthetic mode as default when creating a datastream #1261

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

Merged
merged 5 commits into from
Jun 8, 2023
Merged

Add synthetic mode as default when creating a datastream #1261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d5adcf3
Add synthetic mode as default when creating a datastream
mrodm May 11, 2023
41f308f
Add new question for synthetic source
mrodm May 12, 2023
f3a68b1
Set synthetic source mode just for metrics and the survey question
mrodm Jun 1, 2023
68fb6c4
Add index_mode
mrodm Jun 6, 2023
85ad5b1
Update questions
mrodm Jun 8, 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
67 changes: 59 additions & 8 deletions cmd/create_data_stream.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@ const createDataStreamLongDescription = `Use this command to create a new data s
The command can extend the package with a new data stream using embedded data stream template and wizard.`

type newDataStreamAnswers struct {
Name string
Title string
Type string
Name string
Title string
Type string
SyntheticAndTimeSeries bool
Synthetic bool
}

func createDataStreamCommandAction(cmd *cobra.Command, args []string) error {
Expand Down Expand Up @@ -68,6 +70,40 @@ func createDataStreamCommandAction(cmd *cobra.Command, args []string) error {
return errors.Wrap(err, "prompt failed")
}

if answers.Type == "metrics" {
qs := []*survey.Question{
{
Name: "syntheticAndTimeSeries",
Prompt: &survey.Confirm{
Message: "Enable time series and synthetic source?",
Default: true,
},
Validate: survey.Required,
},
}
err = survey.Ask(qs, &answers)
if err != nil {
return errors.Wrap(err, "prompt failed")
}

if !answers.SyntheticAndTimeSeries {
qs := []*survey.Question{
{
Name: "synthetic",
Prompt: &survey.Confirm{
Message: "Enable synthetic source?",
Default: true,
},
Validate: survey.Required,
},
}
err = survey.Ask(qs, &answers)
if err != nil {
return errors.Wrap(err, "prompt failed")
}
}
}

descriptor := createDataStreamDescriptorFromAnswers(answers, packageRoot)
err = archetype.CreateDataStream(descriptor)
if err != nil {
Expand All @@ -79,12 +115,27 @@ func createDataStreamCommandAction(cmd *cobra.Command, args []string) error {
}

func createDataStreamDescriptorFromAnswers(answers newDataStreamAnswers, packageRoot string) archetype.DataStreamDescriptor {
manifest := packages.DataStreamManifest{
Name: answers.Name,
Title: answers.Title,
Type: answers.Type,
}

if !answers.SyntheticAndTimeSeries && !answers.Synthetic {
return archetype.DataStreamDescriptor{
Manifest: manifest,
PackageRoot: packageRoot,
}
}
elasticsearch := packages.Elasticsearch{
SourceMode: "synthetic",
}
if answers.SyntheticAndTimeSeries {
elasticsearch.IndexMode = "time_series"
}
manifest.Elasticsearch = &elasticsearch
return archetype.DataStreamDescriptor{
Manifest: packages.DataStreamManifest{
Name: answers.Name,
Title: answers.Title,
Type: answers.Type,
},
Manifest: manifest,
PackageRoot: packageRoot,
}
}
9 changes: 9 additions & 0 deletions internal/packages/archetype/data_stream_manifest.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,14 @@ streams:{{if eq .Manifest.Type "logs" }}
type: text
title: Period
default: 10s
{{ if .Manifest.Elasticsearch }}
elasticsearch:
{{ if .Manifest.Elasticsearch.SourceMode }}
source_mode: {{ .Manifest.Elasticsearch.SourceMode }}
{{- end}}
{{ if .Manifest.Elasticsearch.IndexMode }}
index_mode: {{ .Manifest.Elasticsearch.IndexMode }}
{{- end}}
{{- end}}
{{- end}}
`
32 changes: 18 additions & 14 deletions internal/packages/packages.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,22 +132,26 @@ type PackageManifest struct {
Categories []string `config:"categories" json:"categories" yaml:"categories"`
}

type Elasticsearch struct {
IndexTemplate *struct {
IngestPipeline *struct {
Name string `config:"name" json:"name" yaml:"name"`
} `config:"ingest_pipeline" json:"ingest_pipeline" yaml:"ingest_pipeline"`
} `config:"index_template" json:"index_template" yaml:"index_template"`
SourceMode string `config:"source_mode" json:"source_mode" yaml:"source_mode"`
IndexMode string `config:"index_mode" json:"index_mode" yaml:"index_mode"`
}

// DataStreamManifest represents the structure of a data stream's manifest
type DataStreamManifest struct {
Name string `config:"name" json:"name" yaml:"name"`
Title string `config:"title" json:"title" yaml:"title"`
Type string `config:"type" json:"type" yaml:"type"`
Dataset string `config:"dataset" json:"dataset" yaml:"dataset"`
Hidden bool `config:"hidden" json:"hidden" yaml:"hidden"`
Release string `config:"release" json:"release" yaml:"release"`
Elasticsearch *struct {
IndexTemplate *struct {
IngestPipeline *struct {
Name string `config:"name" json:"name" yaml:"name"`
} `config:"ingest_pipeline" json:"ingest_pipeline" yaml:"ingest_pipeline"`
} `config:"index_template" json:"index_template" yaml:"index_template"`
} `config:"elasticsearch" json:"elasticsearch" yaml:"elasticsearch"`
Streams []struct {
Name string `config:"name" json:"name" yaml:"name"`
Title string `config:"title" json:"title" yaml:"title"`
Type string `config:"type" json:"type" yaml:"type"`
Dataset string `config:"dataset" json:"dataset" yaml:"dataset"`
Hidden bool `config:"hidden" json:"hidden" yaml:"hidden"`
Release string `config:"release" json:"release" yaml:"release"`
Elasticsearch *Elasticsearch `config:"elasticsearch" json:"elasticsearch" yaml:"elasticsearch"`
Streams []struct {
Input string `config:"input" json:"input" yaml:"input"`
Vars []Variable `config:"vars" json:"vars" yaml:"vars"`
} `config:"streams" json:"streams" yaml:"streams"`
Expand Down