-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Filebeat X-Pack Module Packaging (#8615)
This PR adds an intermediate solution for packaging X-Pack modules with Filebeat. In this PR the dashboards, configuration files, and fields are generated in x-pack/filebeat. Packaging is still done entirely from the OSS filebeat directory by making the build run `mage update` in x-pack/filebeat then customizing the packaging configuration to point to different dashboards, config, and fields.yml for the Elastic licensed packages. Long term we will build, test, and package the OSS and Elastic licensed Beats from their respective directories, but this gives us a smaller step in order to be able to release the X-Pack content before the build system is fully transitioned. Co-authored-by: Adrian Serrano <adrisr83@gmail.com> Co-authored-by: Andrew Kroh <andrew.kroh@elastic.co>
- Loading branch information
1 parent
4d60173
commit 69cce4c
Showing
20 changed files
with
3,040 additions
and
136 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| // Licensed to Elasticsearch B.V. under one or more contributor | ||
| // license agreements. See the NOTICE file distributed with | ||
| // this work for additional information regarding copyright | ||
| // ownership. Elasticsearch B.V. licenses this file to you under | ||
| // the Apache License, Version 2.0 (the "License"); you may | ||
| // not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "flag" | ||
| "fmt" | ||
| "go/format" | ||
| "io/ioutil" | ||
| "log" | ||
| "os" | ||
| "path" | ||
|
|
||
| "github.com/elastic/beats/libbeat/asset" | ||
| "github.com/elastic/beats/libbeat/generator/fields" | ||
| "github.com/elastic/beats/licenses" | ||
| ) | ||
|
|
||
| var usageText = ` | ||
| Usage: module_fields [flags] [module-dir] | ||
| module_fields generates a fields.go file containing a copy of the module's | ||
| field.yml data in a format that can be embedded in Beat's binary. module-dir | ||
| should be the directory containing modules (e.g. filebeat/module). | ||
| Options: | ||
| `[1:] | ||
|
|
||
| var ( | ||
| beatName string | ||
| license string | ||
| ) | ||
|
|
||
| func init() { | ||
| flag.StringVar(&beatName, "beat", "", "Name of the beat. (Required)") | ||
| flag.StringVar(&license, "license", "ASL2", "License header for generated file.") | ||
| flag.Usage = usageFlag | ||
| } | ||
|
|
||
| func main() { | ||
| log.SetFlags(0) | ||
| flag.Parse() | ||
|
|
||
| if beatName == "" { | ||
| log.Fatal("You must use -beat to specify the beat name.") | ||
| } | ||
|
|
||
| license, err := licenses.Find(license) | ||
| if err != nil { | ||
| log.Fatalf("Invalid license specifier: %v", err) | ||
| } | ||
|
|
||
| args := flag.Args() | ||
| if len(args) != 1 { | ||
| log.Fatal("module-dir must be passed as an argument.") | ||
| } | ||
| dir := args[0] | ||
|
|
||
| modules, err := fields.GetModules(dir) | ||
| if err != nil { | ||
| log.Fatalf("Error fetching modules: %v", err) | ||
| } | ||
|
|
||
| for _, module := range modules { | ||
| files, err := fields.CollectFiles(module, dir) | ||
| if err != nil { | ||
| log.Fatalf("Error fetching files for module %v: %v", module, err) | ||
| } | ||
|
|
||
| data, err := fields.GenerateFieldsYml(files) | ||
| if err != nil { | ||
| log.Fatalf("Error fetching files for module %v: %v", module, err) | ||
| } | ||
|
|
||
| encData, err := asset.EncodeData(string(data)) | ||
| if err != nil { | ||
| log.Fatalf("Error encoding the data: %v", err) | ||
| } | ||
|
|
||
| var buf bytes.Buffer | ||
| asset.Template.Execute(&buf, asset.Data{ | ||
| License: license, | ||
| Beat: beatName, | ||
| Name: module, | ||
| Data: encData, | ||
| Package: module, | ||
| }) | ||
|
|
||
| bs, err := format.Source(buf.Bytes()) | ||
| if err != nil { | ||
| log.Fatalf("Error creating golang file from template: %v", err) | ||
| } | ||
|
|
||
| err = ioutil.WriteFile(path.Join(dir, module, "fields.go"), bs, 0644) | ||
| if err != nil { | ||
| log.Fatalf("Error writing fields.go: %v", err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func usageFlag() { | ||
| fmt.Fprintf(os.Stderr, usageText) | ||
| flag.PrintDefaults() | ||
| } |
Oops, something went wrong.