serverstatus

package
v2.116.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 24, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetSystemReport added in v2.116.0 

func GetSystemReport(client newclient.Client) (io.ReadCloser, error)

GetSystemReport returns the server's diagnostic report, a zip archive. The caller is responsible for closing the returned reader. Requires the AdministerSystem permission.

Types

type DocumentCounts added in v2.116.0 

type DocumentCounts struct {
	Global         GlobalDocumentCounts         `json:"Global"`
	Infrastructure InfrastructureDocumentCounts `json:"Infrastructure"`
	Library        LibraryDocumentCounts        `json:"Library"`
	Project        ProjectDocumentCounts        `json:"Project"`
}

func GetDocumentCounts added in v2.116.0 

func GetDocumentCounts(client newclient.Client) (*DocumentCounts, error)

GetDocumentCounts returns the number of documents held by the server, grouped by area.

type GlobalDocumentCounts added in v2.116.0 

type GlobalDocumentCounts struct {
	Spaces int `json:"Spaces"`
	Teams  int `json:"Teams"`
	Users  int `json:"Users"`
}

type InfrastructureDocumentCounts added in v2.116.0 

type InfrastructureDocumentCounts struct {
	DeploymentTargets int `json:"DeploymentTargets"`
	Environments      int `json:"Environments"`
	Tenants           int `json:"Tenants"`
	WorkerPools       int `json:"WorkerPools"`
	Workers           int `json:"Workers"`
}

type LibraryDocumentCounts added in v2.116.0 

type LibraryDocumentCounts struct {
	Certificates int `json:"Certificates"`
	Packages     int `json:"Packages"`
	VariableSets int `json:"VariableSets"`
}

type LogEntry added in v2.116.0 

type LogEntry struct {
	Category    string     `json:"Category,omitempty"`
	Detail      string     `json:"Detail,omitempty"`
	MessageText string     `json:"MessageText,omitempty"`
	Number      int        `json:"Number"`
	OccurredAt  *time.Time `json:"OccurredAt,omitempty"`
}

func GetRecentLogs added in v2.116.0 

func GetRecentLogs(client newclient.Client, logsQuery LogsQuery) ([]*LogEntry, error)

GetRecentLogs returns recent entries from the server log. Requires the AdministerSystem permission.

type LogsQuery added in v2.116.0 

type LogsQuery struct {
	IncludeDetail bool `uri:"includeDetail,omitempty" url:"includeDetail,omitempty"`
	Skip          int  `uri:"skip,omitempty" url:"skip,omitempty"`
	Take          int  `uri:"take,omitempty" url:"take,omitempty"`
}

LogsQuery represents parameters to query the recent server logs.

type ProjectDocumentCounts added in v2.116.0 

type ProjectDocumentCounts struct {
	Deployments int `json:"Deployments"`
	Projects    int `json:"Projects"`
	Releases    int `json:"Releases"`
	RunbookRuns int `json:"RunbookRuns"`
	Runbooks    int `json:"Runbooks"`
}

type ServerHealthStatus added in v2.116.0 

type ServerHealthStatus struct {
	Description                  string `json:"Description,omitempty"`
	IsCompliantWithLicense       bool   `json:"IsCompliantWithLicense"`
	IsEntireClusterDrainingTasks bool   `json:"IsEntireClusterDrainingTasks"`
	IsEntireClusterReadOnly      bool   `json:"IsEntireClusterReadOnly"`
	IsOperatingNormally          bool   `json:"IsOperatingNormally"`

	resources.Resource
}

func GetHealthStatus added in v2.116.0 

func GetHealthStatus(client newclient.Client) (*ServerHealthStatus, error)

GetHealthStatus returns the health of the server cluster.

type ServerStatus 

type ServerStatus struct {
	IsDatabaseEncrypted                     bool   `json:"IsDatabaseEncrypted"`
	IsMajorMinorUpgrade                     bool   `json:"IsMajorMinorUpgrade"`
	IsInMaintenanceMode                     bool   `json:"IsInMaintenanceMode"`
	IsPotentialClone                        bool   `json:"IsPotentialClone"`
	IsUpgradeAvailable                      bool   `json:"IsUpgradeAvailable"`
	MaintenanceExpires                      string `json:"MaintenanceExpires,omitempty"`
	MaximumAvailableVersion                 string `json:"MaximumAvailableVersion,omitempty"`
	MaximumAvailableVersionCoveredByLicense string `json:"MaximumAvailableVersionCoveredByLicense,omitempty"`

	resources.Resource
}

func GetServerStatus added in v2.116.0 

func GetServerStatus(client newclient.Client) (*ServerStatus, error)

GetServerStatus returns the status of the server.

type ServerStatusService 

type ServerStatusService struct {
	services.Service
	// contains filtered or unexported fields
}

func NewServerStatusService 

func NewServerStatusService(sling *sling.Sling, uriTemplate string, extensionStatsPath string, healthStatusPath string, timezonesPath string) *ServerStatusService

func (*ServerStatusService) Get 

func (s *ServerStatusService) Get() (*ServerStatus, error)

Get returns the status of the server.

type SystemInfo added in v2.116.0 

type SystemInfo struct {
	ClrVersion         string `json:"ClrVersion,omitempty"`
	MinThreadPoolCount int    `json:"MinThreadPoolCount"`
	OSVersion          string `json:"OSVersion,omitempty"`
	ThreadCount        int    `json:"ThreadCount"`
	// Uptime is a .NET time span, "[d.]hh:mm:ss[.fffffff]", as sent by the server.
	Uptime          string `json:"Uptime,omitempty"`
	Version         string `json:"Version,omitempty"`
	WorkingSetBytes int64  `json:"WorkingSetBytes"`

	resources.Resource
}

func GetSystemInfo added in v2.116.0 

func GetSystemInfo(client newclient.Client) (*SystemInfo, error)

GetSystemInfo returns diagnostic information about the running server. Requires the AdministerSystem permission.

type Timezone added in v2.116.0 

type Timezone struct {
	IsLocal bool   `json:"IsLocal"`
	Name    string `json:"Name,omitempty"`

	resources.Resource
}

func GetTimezones added in v2.116.0 

func GetTimezones(client newclient.Client) ([]*Timezone, error)

GetTimezones returns the time zones supported by the server.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.