Documentation
¶
Overview ¶
Package bigbluebutton provides gather functionality
Package bigbluebutton provides gather functionality
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BigBlueButton ¶
type BigBlueButton struct {
URL string `toml:"url"`
PathPrefix string `toml:"path_prefix"`
SecretKey string `toml:"secret_key"`
Username string `toml:"username"`
Password string `toml:"password"`
GatherByMetadata []string `toml:"gather_by_metadata"`
tls.ClientConfig
proxy.HTTPProxy
// contains filtered or unexported fields
}
BigBlueButton is the global configuration object
func (*BigBlueButton) Description ¶
func (b *BigBlueButton) Description() string
Description provides a simple description sentence that explain the plugin
func (*BigBlueButton) Gather ¶
func (b *BigBlueButton) Gather(acc telegraf.Accumulator) error
Gather gather data from the BigBlueButton server end send them into the telegraf accumulator
func (*BigBlueButton) Init ¶
func (b *BigBlueButton) Init() error
Init initialize the BigBlueButton struct with precalculated data
func (*BigBlueButton) SampleConfig ¶
func (b *BigBlueButton) SampleConfig() string
SampleConfig provides a sample config object
type HealthCheck ¶ added in v1.1.0
type HealthCheck struct {
XMLName xml.Name `xml:"response"`
ReturnCode string `xml:"returncode"`
Version string `xml:"version"`
}
HealthCheck is a api health check response
type Meeting ¶
type Meeting struct {
XMLName xml.Name `xml:"meeting"`
ParticipantCount uint64 `xml:"participantCount"`
ListenerCount uint64 `xml:"listenerCount"`
VoiceParticipantCount uint64 `xml:"voiceParticipantCount"`
VideoCount uint64 `xml:"videoCount"`
Recording bool `xml:"recording"`
Metadata Metadata `xml:"metadata"`
ParsedMetadata map[string]string
}
Meeting is a meeting response containing information like name, id, created time, created date, ...
type MeetingsResponse ¶
type MeetingsResponse struct {
XMLName xml.Name `xml:"response"`
ReturnCode string `xml:"returncode"`
MessageKey string `xml:"messageKey"`
Meetings Meetings `xml:"meetings"`
}
MeetingsResponse is BigBlueButton XML global getMeetings api reponse type
type Recording ¶
type Recording struct {
XMLName xml.Name `xml:"recording"`
RecordID string `xml:"recordID"`
Published bool `xml:"published"`
Metadata Metadata `xml:"metadata"`
ParsedMetadata map[string]string
}
Recording is recording response containt information like state, record identifier, ...
type Recordings ¶
Recordings is BigBlueButton XML recordings section
type RecordingsResponse ¶
type RecordingsResponse struct {
XMLName xml.Name `xml:"response"`
ReturnCode string `xml:"returncode"`
MessageKey string `xml:"messageKey"`
Recordings Recordings `xml:"recordings"`
}
RecordingsResponse is BigBlueButton XML global getRecordings api response type