升级流程引擎配置文件版本
This commit is contained in:
+190
@@ -0,0 +1,190 @@
|
||||
// Copyright (C) MongoDB, Inc. 2017-present.
|
||||
//
|
||||
// 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
|
||||
|
||||
package event // import "go.mongodb.org/mongo-driver/event"
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"go.mongodb.org/mongo-driver/bson"
|
||||
"go.mongodb.org/mongo-driver/bson/primitive"
|
||||
"go.mongodb.org/mongo-driver/mongo/address"
|
||||
"go.mongodb.org/mongo-driver/mongo/description"
|
||||
)
|
||||
|
||||
// CommandStartedEvent represents an event generated when a command is sent to a server.
|
||||
type CommandStartedEvent struct {
|
||||
Command bson.Raw
|
||||
DatabaseName string
|
||||
CommandName string
|
||||
RequestID int64
|
||||
ConnectionID string
|
||||
// ServerConnectionID contains the connection ID from the server of the operation. If the server does not return
|
||||
// this value (e.g. on MDB < 4.2), it is unset.
|
||||
ServerConnectionID *int32
|
||||
// ServiceID contains the ID of the server to which the command was sent if it is running behind a load balancer.
|
||||
// Otherwise, it is unset.
|
||||
ServiceID *primitive.ObjectID
|
||||
}
|
||||
|
||||
// CommandFinishedEvent represents a generic command finishing.
|
||||
type CommandFinishedEvent struct {
|
||||
DurationNanos int64
|
||||
CommandName string
|
||||
RequestID int64
|
||||
ConnectionID string
|
||||
// ServerConnectionID contains the connection ID from the server of the operation. If the server does not return
|
||||
// this value (e.g. on MDB < 4.2), it is unset.
|
||||
ServerConnectionID *int32
|
||||
// ServiceID contains the ID of the server to which the command was sent if it is running behind a load balancer.
|
||||
// Otherwise, it is unset.
|
||||
ServiceID *primitive.ObjectID
|
||||
}
|
||||
|
||||
// CommandSucceededEvent represents an event generated when a command's execution succeeds.
|
||||
type CommandSucceededEvent struct {
|
||||
CommandFinishedEvent
|
||||
Reply bson.Raw
|
||||
}
|
||||
|
||||
// CommandFailedEvent represents an event generated when a command's execution fails.
|
||||
type CommandFailedEvent struct {
|
||||
CommandFinishedEvent
|
||||
Failure string
|
||||
}
|
||||
|
||||
// CommandMonitor represents a monitor that is triggered for different events.
|
||||
type CommandMonitor struct {
|
||||
Started func(context.Context, *CommandStartedEvent)
|
||||
Succeeded func(context.Context, *CommandSucceededEvent)
|
||||
Failed func(context.Context, *CommandFailedEvent)
|
||||
}
|
||||
|
||||
// strings for pool command monitoring reasons
|
||||
const (
|
||||
ReasonIdle = "idle"
|
||||
ReasonPoolClosed = "poolClosed"
|
||||
ReasonStale = "stale"
|
||||
ReasonConnectionErrored = "connectionError"
|
||||
ReasonTimedOut = "timeout"
|
||||
ReasonError = "error"
|
||||
)
|
||||
|
||||
// strings for pool command monitoring types
|
||||
const (
|
||||
PoolCreated = "ConnectionPoolCreated"
|
||||
PoolReady = "ConnectionPoolReady"
|
||||
PoolCleared = "ConnectionPoolCleared"
|
||||
PoolClosedEvent = "ConnectionPoolClosed"
|
||||
ConnectionCreated = "ConnectionCreated"
|
||||
ConnectionReady = "ConnectionReady"
|
||||
ConnectionClosed = "ConnectionClosed"
|
||||
GetStarted = "ConnectionCheckOutStarted"
|
||||
GetFailed = "ConnectionCheckOutFailed"
|
||||
GetSucceeded = "ConnectionCheckedOut"
|
||||
ConnectionReturned = "ConnectionCheckedIn"
|
||||
)
|
||||
|
||||
// MonitorPoolOptions contains pool options as formatted in pool events
|
||||
type MonitorPoolOptions struct {
|
||||
MaxPoolSize uint64 `json:"maxPoolSize"`
|
||||
MinPoolSize uint64 `json:"minPoolSize"`
|
||||
WaitQueueTimeoutMS uint64 `json:"maxIdleTimeMS"`
|
||||
}
|
||||
|
||||
// PoolEvent contains all information summarizing a pool event
|
||||
type PoolEvent struct {
|
||||
Type string `json:"type"`
|
||||
Address string `json:"address"`
|
||||
ConnectionID uint64 `json:"connectionId"`
|
||||
PoolOptions *MonitorPoolOptions `json:"options"`
|
||||
Reason string `json:"reason"`
|
||||
// ServiceID is only set if the Type is PoolCleared and the server is deployed behind a load balancer. This field
|
||||
// can be used to distinguish between individual servers in a load balanced deployment.
|
||||
ServiceID *primitive.ObjectID `json:"serviceId"`
|
||||
}
|
||||
|
||||
// PoolMonitor is a function that allows the user to gain access to events occurring in the pool
|
||||
type PoolMonitor struct {
|
||||
Event func(*PoolEvent)
|
||||
}
|
||||
|
||||
// ServerDescriptionChangedEvent represents a server description change.
|
||||
type ServerDescriptionChangedEvent struct {
|
||||
Address address.Address
|
||||
TopologyID primitive.ObjectID // A unique identifier for the topology this server is a part of
|
||||
PreviousDescription description.Server
|
||||
NewDescription description.Server
|
||||
}
|
||||
|
||||
// ServerOpeningEvent is an event generated when the server is initialized.
|
||||
type ServerOpeningEvent struct {
|
||||
Address address.Address
|
||||
TopologyID primitive.ObjectID // A unique identifier for the topology this server is a part of
|
||||
}
|
||||
|
||||
// ServerClosedEvent is an event generated when the server is closed.
|
||||
type ServerClosedEvent struct {
|
||||
Address address.Address
|
||||
TopologyID primitive.ObjectID // A unique identifier for the topology this server is a part of
|
||||
}
|
||||
|
||||
// TopologyDescriptionChangedEvent represents a topology description change.
|
||||
type TopologyDescriptionChangedEvent struct {
|
||||
TopologyID primitive.ObjectID // A unique identifier for the topology this server is a part of
|
||||
PreviousDescription description.Topology
|
||||
NewDescription description.Topology
|
||||
}
|
||||
|
||||
// TopologyOpeningEvent is an event generated when the topology is initialized.
|
||||
type TopologyOpeningEvent struct {
|
||||
TopologyID primitive.ObjectID // A unique identifier for the topology this server is a part of
|
||||
}
|
||||
|
||||
// TopologyClosedEvent is an event generated when the topology is closed.
|
||||
type TopologyClosedEvent struct {
|
||||
TopologyID primitive.ObjectID // A unique identifier for the topology this server is a part of
|
||||
}
|
||||
|
||||
// ServerHeartbeatStartedEvent is an event generated when the heartbeat is started.
|
||||
type ServerHeartbeatStartedEvent struct {
|
||||
ConnectionID string // The address this heartbeat was sent to with a unique identifier
|
||||
Awaited bool // If this heartbeat was awaitable
|
||||
}
|
||||
|
||||
// ServerHeartbeatSucceededEvent is an event generated when the heartbeat succeeds.
|
||||
type ServerHeartbeatSucceededEvent struct {
|
||||
DurationNanos int64
|
||||
Reply description.Server
|
||||
ConnectionID string // The address this heartbeat was sent to with a unique identifier
|
||||
Awaited bool // If this heartbeat was awaitable
|
||||
}
|
||||
|
||||
// ServerHeartbeatFailedEvent is an event generated when the heartbeat fails.
|
||||
type ServerHeartbeatFailedEvent struct {
|
||||
DurationNanos int64
|
||||
Failure error
|
||||
ConnectionID string // The address this heartbeat was sent to with a unique identifier
|
||||
Awaited bool // If this heartbeat was awaitable
|
||||
}
|
||||
|
||||
// ServerMonitor represents a monitor that is triggered for different server events. The client
|
||||
// will monitor changes on the MongoDB deployment it is connected to, and this monitor reports
|
||||
// the changes in the client's representation of the deployment. The topology represents the
|
||||
// overall deployment, and heartbeats are sent to individual servers to check their current status.
|
||||
type ServerMonitor struct {
|
||||
ServerDescriptionChanged func(*ServerDescriptionChangedEvent)
|
||||
ServerOpening func(*ServerOpeningEvent)
|
||||
ServerClosed func(*ServerClosedEvent)
|
||||
// TopologyDescriptionChanged is called when the topology is locked, so the callback should
|
||||
// not attempt any operation that requires server selection on the same client.
|
||||
TopologyDescriptionChanged func(*TopologyDescriptionChangedEvent)
|
||||
TopologyOpening func(*TopologyOpeningEvent)
|
||||
TopologyClosed func(*TopologyClosedEvent)
|
||||
ServerHeartbeatStarted func(*ServerHeartbeatStartedEvent)
|
||||
ServerHeartbeatSucceeded func(*ServerHeartbeatSucceededEvent)
|
||||
ServerHeartbeatFailed func(*ServerHeartbeatFailedEvent)
|
||||
}
|
||||
Reference in New Issue
Block a user