forked from vmware/govmomi
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add task manager and collector
This change introduces a task manager (https://vdc-download.vmware.com/vmwb-repository/dcr-public/8946c1b6-2861-4c12-a45f-f14ae0d3b1b9/a5b8094c-c222-4307-9399-3b606a04af55/vim.TaskManager.html) with support for creating a task history collector. History collector is moved from object into its own package and changes were made to the event package accordingly (collector logic is shared between task and event manager). BREAKING: `event.Manager` does not embed `object.Common` anymore. Only the methods `Client()` and `Reference()` are implemented. `event.NewHistoryCollector()` is now unexported (to `newHistoryCollector()`) as it was merely a helper and to comply with the task manager implementation. Closes: vmware#2497 Signed-off-by: Michael Gasch <[email protected]>
- Loading branch information
Michael Gasch
committed
Sep 2, 2021
1 parent
6258af3
commit 397c8aa
Showing
8 changed files
with
341 additions
and
93 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,94 @@ | ||
| /* | ||
| Copyright (c) 2020 VMware, Inc. All Rights Reserved. | ||
| Licensed 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 ( | ||
| "context" | ||
| "flag" | ||
| "time" | ||
|
|
||
| "github.com/kr/pretty" | ||
|
|
||
| "github.com/vmware/govmomi/task" | ||
|
|
||
| "github.com/vmware/govmomi/examples" | ||
| "github.com/vmware/govmomi/vim25" | ||
| "github.com/vmware/govmomi/vim25/methods" | ||
| "github.com/vmware/govmomi/vim25/types" | ||
| ) | ||
|
|
||
| func main() { | ||
| // example use against vCenter with optional time filters: | ||
| // go run main.go -url $GOVMOMI_URL -insecure $GOVMOMI_INSECURE -b 8h -f | ||
| begin := flag.Duration("b", 10*time.Minute, "Begin time (filtered by started time)") // default BeginTime is 10min ago | ||
| end := flag.Duration("e", 0, "End time (filtered by started time)") | ||
| follow := flag.Bool("f", false, "Follow task stream") | ||
|
|
||
| examples.Run(func(ctx context.Context, c *vim25.Client) error { | ||
| m := task.NewManager(c) | ||
|
|
||
| ref := c.ServiceContent.RootFolder | ||
|
|
||
| now, err := methods.GetCurrentTime(ctx, c) // vCenter server time (UTC) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| filter := types.TaskFilterSpec{ | ||
| Entity: &types.TaskFilterSpecByEntity{ | ||
| Entity: ref, | ||
| Recursion: types.TaskFilterSpecRecursionOptionAll, | ||
| }, | ||
| Time: &types.TaskFilterSpecByTime{ | ||
| TimeType: types.TaskFilterSpecTimeOptionStartedTime, | ||
| BeginTime: types.NewTime(now.Add(*begin * -1)), | ||
| }, | ||
| } | ||
|
|
||
| if *end != 0 { | ||
| filter.Time.EndTime = types.NewTime(now.Add(*end * -1)) | ||
| } | ||
|
|
||
| collector, err := m.CreateCollectorForTasks(ctx, filter) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| defer collector.Destroy(ctx) | ||
|
|
||
| for { | ||
| tasks, err := collector.ReadNextTasks(ctx, 10) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if len(tasks) == 0 { | ||
| if *follow { | ||
| time.Sleep(time.Second) | ||
| continue | ||
| } | ||
| break | ||
| } | ||
|
|
||
| for i := range tasks { | ||
| pretty.Println(tasks[i]) | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| }) | ||
| } |
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,91 @@ | ||
| /* | ||
| Copyright (c) 2015 VMware, Inc. All Rights Reserved. | ||
| Licensed 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 history | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/vmware/govmomi/property" | ||
| "github.com/vmware/govmomi/vim25" | ||
| "github.com/vmware/govmomi/vim25/methods" | ||
| "github.com/vmware/govmomi/vim25/types" | ||
| ) | ||
|
|
||
| type Collector struct { | ||
| r types.ManagedObjectReference | ||
| c *vim25.Client | ||
| } | ||
|
|
||
| func NewCollector(c *vim25.Client, ref types.ManagedObjectReference) *Collector { | ||
| return &Collector{ | ||
| r: ref, | ||
| c: c, | ||
| } | ||
| } | ||
|
|
||
| // Reference returns the managed object reference of this collector | ||
| func (c Collector) Reference() types.ManagedObjectReference { | ||
| return c.r | ||
| } | ||
|
|
||
| // Client returns the vim25 client used by this collector | ||
| func (c Collector) Client() *vim25.Client { | ||
| return c.c | ||
| } | ||
|
|
||
| // Properties wraps property.DefaultCollector().RetrieveOne() and returns | ||
| // properties for the specified managed object reference | ||
| func (c Collector) Properties(ctx context.Context, r types.ManagedObjectReference, ps []string, dst interface{}) error { | ||
| return property.DefaultCollector(c.c).RetrieveOne(ctx, r, ps, dst) | ||
| } | ||
|
|
||
| func (c Collector) Destroy(ctx context.Context) error { | ||
| req := types.DestroyCollector{ | ||
| This: c.r, | ||
| } | ||
|
|
||
| _, err := methods.DestroyCollector(ctx, c.c, &req) | ||
| return err | ||
| } | ||
|
|
||
| func (c Collector) Reset(ctx context.Context) error { | ||
| req := types.ResetCollector{ | ||
| This: c.r, | ||
| } | ||
|
|
||
| _, err := methods.ResetCollector(ctx, c.c, &req) | ||
| return err | ||
| } | ||
|
|
||
| func (c Collector) Rewind(ctx context.Context) error { | ||
| req := types.RewindCollector{ | ||
| This: c.r, | ||
| } | ||
|
|
||
| _, err := methods.RewindCollector(ctx, c.c, &req) | ||
| return err | ||
| } | ||
|
|
||
| func (c Collector) SetPageSize(ctx context.Context, maxCount int32) error { | ||
| req := types.SetCollectorPageSize{ | ||
| This: c.r, | ||
| MaxCount: maxCount, | ||
| } | ||
|
|
||
| _, err := methods.SetCollectorPageSize(ctx, c.c, &req) | ||
| return err | ||
| } |
Oops, something went wrong.