| Copyright | (c) 2015-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.Logging.Types
Contents
- Service Configuration
- OAuth Scopes
- MonitoredResourceDescriptor
- ListLogEntriesResponse
- MonitoredResourceLabels
- LogMetricVersion
- ListLogMetricsResponse
- WriteLogEntriesRequest
- LogSinkOutputVersionFormat
- Empty
- LogEntryLabels
- ListSinksResponse
- RequestLog
- LogEntryProtoPayload
- LogEntrySourceLocation
- WriteLogEntriesResponse
- LogSink
- ListLogsResponse
- ListMonitoredResourceDescriptorsResponse
- LabelDescriptorValueType
- HTTPRequest
- WriteLogEntriesRequestLabels
- MonitoredResource
- Xgafv
- LogLine
- LabelDescriptor
- ListLogEntriesRequest
- LogEntryOperation
- LogMetric
- LogEntry
- SourceLocation
- LogEntrySeverity
- SourceReference
- LogEntryJSONPayload
- LogLineSeverity
Description
- loggingService :: ServiceConfig
- loggingAdminScope :: Proxy '["https://www.googleapis.com/auth/logging.admin"]
- loggingReadScope :: Proxy '["https://www.googleapis.com/auth/logging.read"]
- loggingWriteScope :: Proxy '["https://www.googleapis.com/auth/logging.write"]
- cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"]
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- data MonitoredResourceDescriptor
- monitoredResourceDescriptor :: MonitoredResourceDescriptor
- mrdName :: Lens' MonitoredResourceDescriptor (Maybe Text)
- mrdDisplayName :: Lens' MonitoredResourceDescriptor (Maybe Text)
- mrdLabels :: Lens' MonitoredResourceDescriptor [LabelDescriptor]
- mrdType :: Lens' MonitoredResourceDescriptor (Maybe Text)
- mrdDescription :: Lens' MonitoredResourceDescriptor (Maybe Text)
- data ListLogEntriesResponse
- listLogEntriesResponse :: ListLogEntriesResponse
- llerNextPageToken :: Lens' ListLogEntriesResponse (Maybe Text)
- llerEntries :: Lens' ListLogEntriesResponse [LogEntry]
- data MonitoredResourceLabels
- monitoredResourceLabels :: HashMap Text Text -> MonitoredResourceLabels
- mrlAddtional :: Lens' MonitoredResourceLabels (HashMap Text Text)
- data LogMetricVersion
- data ListLogMetricsResponse
- listLogMetricsResponse :: ListLogMetricsResponse
- llmrMetrics :: Lens' ListLogMetricsResponse [LogMetric]
- llmrNextPageToken :: Lens' ListLogMetricsResponse (Maybe Text)
- data WriteLogEntriesRequest
- writeLogEntriesRequest :: WriteLogEntriesRequest
- wlerEntries :: Lens' WriteLogEntriesRequest [LogEntry]
- wlerPartialSuccess :: Lens' WriteLogEntriesRequest (Maybe Bool)
- wlerResource :: Lens' WriteLogEntriesRequest (Maybe MonitoredResource)
- wlerLabels :: Lens' WriteLogEntriesRequest (Maybe WriteLogEntriesRequestLabels)
- wlerLogName :: Lens' WriteLogEntriesRequest (Maybe Text)
- data LogSinkOutputVersionFormat
- data Empty
- empty :: Empty
- data LogEntryLabels
- logEntryLabels :: HashMap Text Text -> LogEntryLabels
- lelAddtional :: Lens' LogEntryLabels (HashMap Text Text)
- data ListSinksResponse
- listSinksResponse :: ListSinksResponse
- lsrSinks :: Lens' ListSinksResponse [LogSink]
- lsrNextPageToken :: Lens' ListSinksResponse (Maybe Text)
- data RequestLog
- requestLog :: RequestLog
- rlTraceId :: Lens' RequestLog (Maybe Text)
- rlInstanceId :: Lens' RequestLog (Maybe Text)
- rlStatus :: Lens' RequestLog (Maybe Int32)
- rlRequestId :: Lens' RequestLog (Maybe Text)
- rlInstanceIndex :: Lens' RequestLog (Maybe Int32)
- rlModuleId :: Lens' RequestLog (Maybe Text)
- rlVersionId :: Lens' RequestLog (Maybe Text)
- rlHTTPVersion :: Lens' RequestLog (Maybe Text)
- rlTaskName :: Lens' RequestLog (Maybe Text)
- rlPendingTime :: Lens' RequestLog (Maybe Scientific)
- rlWasLoadingRequest :: Lens' RequestLog (Maybe Bool)
- rlFirst :: Lens' RequestLog (Maybe Bool)
- rlStartTime :: Lens' RequestLog (Maybe UTCTime)
- rlLatency :: Lens' RequestLog (Maybe Scientific)
- rlURLMapEntry :: Lens' RequestLog (Maybe Text)
- rlCost :: Lens' RequestLog (Maybe Double)
- rlReferrer :: Lens' RequestLog (Maybe Text)
- rlLine :: Lens' RequestLog [LogLine]
- rlIP :: Lens' RequestLog (Maybe Text)
- rlAppId :: Lens' RequestLog (Maybe Text)
- rlMethod :: Lens' RequestLog (Maybe Text)
- rlResource :: Lens' RequestLog (Maybe Text)
- rlEndTime :: Lens' RequestLog (Maybe UTCTime)
- rlFinished :: Lens' RequestLog (Maybe Bool)
- rlMegaCycles :: Lens' RequestLog (Maybe Int64)
- rlUserAgent :: Lens' RequestLog (Maybe Text)
- rlNickname :: Lens' RequestLog (Maybe Text)
- rlHost :: Lens' RequestLog (Maybe Text)
- rlTaskQueueName :: Lens' RequestLog (Maybe Text)
- rlResponseSize :: Lens' RequestLog (Maybe Int64)
- rlSourceReference :: Lens' RequestLog [SourceReference]
- rlAppEngineRelease :: Lens' RequestLog (Maybe Text)
- data LogEntryProtoPayload
- logEntryProtoPayload :: HashMap Text JSONValue -> LogEntryProtoPayload
- leppAddtional :: Lens' LogEntryProtoPayload (HashMap Text JSONValue)
- data LogEntrySourceLocation
- logEntrySourceLocation :: LogEntrySourceLocation
- leslFunction :: Lens' LogEntrySourceLocation (Maybe Text)
- leslLine :: Lens' LogEntrySourceLocation (Maybe Int64)
- leslFile :: Lens' LogEntrySourceLocation (Maybe Text)
- data WriteLogEntriesResponse
- writeLogEntriesResponse :: WriteLogEntriesResponse
- data LogSink
- logSink :: LogSink
- lsDestination :: Lens' LogSink (Maybe Text)
- lsStartTime :: Lens' LogSink (Maybe UTCTime)
- lsOutputVersionFormat :: Lens' LogSink (Maybe LogSinkOutputVersionFormat)
- lsWriterIdentity :: Lens' LogSink (Maybe Text)
- lsName :: Lens' LogSink (Maybe Text)
- lsEndTime :: Lens' LogSink (Maybe UTCTime)
- lsFilter :: Lens' LogSink (Maybe Text)
- data ListLogsResponse
- listLogsResponse :: ListLogsResponse
- llrNextPageToken :: Lens' ListLogsResponse (Maybe Text)
- llrLogNames :: Lens' ListLogsResponse [Text]
- data ListMonitoredResourceDescriptorsResponse
- listMonitoredResourceDescriptorsResponse :: ListMonitoredResourceDescriptorsResponse
- lmrdrNextPageToken :: Lens' ListMonitoredResourceDescriptorsResponse (Maybe Text)
- lmrdrResourceDescriptors :: Lens' ListMonitoredResourceDescriptorsResponse [MonitoredResourceDescriptor]
- data LabelDescriptorValueType
- data HTTPRequest
- hTTPRequest :: HTTPRequest
- httprStatus :: Lens' HTTPRequest (Maybe Int32)
- httprRequestURL :: Lens' HTTPRequest (Maybe Text)
- httprCacheFillBytes :: Lens' HTTPRequest (Maybe Int64)
- httprRemoteIP :: Lens' HTTPRequest (Maybe Text)
- httprLatency :: Lens' HTTPRequest (Maybe Scientific)
- httprServerIP :: Lens' HTTPRequest (Maybe Text)
- httprRequestSize :: Lens' HTTPRequest (Maybe Int64)
- httprCacheValidatedWithOriginServer :: Lens' HTTPRequest (Maybe Bool)
- httprUserAgent :: Lens' HTTPRequest (Maybe Text)
- httprCacheLookup :: Lens' HTTPRequest (Maybe Bool)
- httprResponseSize :: Lens' HTTPRequest (Maybe Int64)
- httprRequestMethod :: Lens' HTTPRequest (Maybe Text)
- httprCacheHit :: Lens' HTTPRequest (Maybe Bool)
- httprReferer :: Lens' HTTPRequest (Maybe Text)
- data WriteLogEntriesRequestLabels
- writeLogEntriesRequestLabels :: HashMap Text Text -> WriteLogEntriesRequestLabels
- wlerlAddtional :: Lens' WriteLogEntriesRequestLabels (HashMap Text Text)
- data MonitoredResource
- monitoredResource :: MonitoredResource
- mrLabels :: Lens' MonitoredResource (Maybe MonitoredResourceLabels)
- mrType :: Lens' MonitoredResource (Maybe Text)
- data Xgafv
- data LogLine
- logLine :: LogLine
- llTime :: Lens' LogLine (Maybe UTCTime)
- llSeverity :: Lens' LogLine (Maybe LogLineSeverity)
- llLogMessage :: Lens' LogLine (Maybe Text)
- llSourceLocation :: Lens' LogLine (Maybe SourceLocation)
- data LabelDescriptor
- labelDescriptor :: LabelDescriptor
- ldKey :: Lens' LabelDescriptor (Maybe Text)
- ldValueType :: Lens' LabelDescriptor (Maybe LabelDescriptorValueType)
- ldDescription :: Lens' LabelDescriptor (Maybe Text)
- data ListLogEntriesRequest
- listLogEntriesRequest :: ListLogEntriesRequest
- llerOrderBy :: Lens' ListLogEntriesRequest (Maybe Text)
- llerProjectIds :: Lens' ListLogEntriesRequest [Text]
- llerFilter :: Lens' ListLogEntriesRequest (Maybe Text)
- llerPageToken :: Lens' ListLogEntriesRequest (Maybe Text)
- llerPageSize :: Lens' ListLogEntriesRequest (Maybe Int32)
- llerResourceNames :: Lens' ListLogEntriesRequest [Text]
- data LogEntryOperation
- logEntryOperation :: LogEntryOperation
- leoFirst :: Lens' LogEntryOperation (Maybe Bool)
- leoProducer :: Lens' LogEntryOperation (Maybe Text)
- leoLast :: Lens' LogEntryOperation (Maybe Bool)
- leoId :: Lens' LogEntryOperation (Maybe Text)
- data LogMetric
- logMetric :: LogMetric
- lmName :: Lens' LogMetric (Maybe Text)
- lmVersion :: Lens' LogMetric (Maybe LogMetricVersion)
- lmFilter :: Lens' LogMetric (Maybe Text)
- lmDescription :: Lens' LogMetric (Maybe Text)
- data LogEntry
- logEntry :: LogEntry
- leOperation :: Lens' LogEntry (Maybe LogEntryOperation)
- leSeverity :: Lens' LogEntry (Maybe LogEntrySeverity)
- leTextPayload :: Lens' LogEntry (Maybe Text)
- leJSONPayload :: Lens' LogEntry (Maybe LogEntryJSONPayload)
- leHTTPRequest :: Lens' LogEntry (Maybe HTTPRequest)
- leResource :: Lens' LogEntry (Maybe MonitoredResource)
- leInsertId :: Lens' LogEntry (Maybe Text)
- leLabels :: Lens' LogEntry (Maybe LogEntryLabels)
- leProtoPayload :: Lens' LogEntry (Maybe LogEntryProtoPayload)
- leSourceLocation :: Lens' LogEntry (Maybe LogEntrySourceLocation)
- leLogName :: Lens' LogEntry (Maybe Text)
- leTimestamp :: Lens' LogEntry (Maybe UTCTime)
- leTrace :: Lens' LogEntry (Maybe Text)
- data SourceLocation
- sourceLocation :: SourceLocation
- slLine :: Lens' SourceLocation (Maybe Int64)
- slFunctionName :: Lens' SourceLocation (Maybe Text)
- slFile :: Lens' SourceLocation (Maybe Text)
- data LogEntrySeverity
- data SourceReference
- sourceReference :: SourceReference
- srRepository :: Lens' SourceReference (Maybe Text)
- srRevisionId :: Lens' SourceReference (Maybe Text)
- data LogEntryJSONPayload
- logEntryJSONPayload :: HashMap Text JSONValue -> LogEntryJSONPayload
- lejpAddtional :: Lens' LogEntryJSONPayload (HashMap Text JSONValue)
- data LogLineSeverity
Service Configuration
loggingService :: ServiceConfig #
Default request referring to version v2 of the Stackdriver Logging API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
loggingAdminScope :: Proxy '["https://www.googleapis.com/auth/logging.admin"] #
Administrate log data for your projects
loggingReadScope :: Proxy '["https://www.googleapis.com/auth/logging.read"] #
View log data for your projects
loggingWriteScope :: Proxy '["https://www.googleapis.com/auth/logging.write"] #
Submit log data for your projects
cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"] #
View your data across Google Cloud Platform services
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] #
View and manage your data across Google Cloud Platform services
MonitoredResourceDescriptor
data MonitoredResourceDescriptor #
An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.
See: monitoredResourceDescriptor smart constructor.
monitoredResourceDescriptor :: MonitoredResourceDescriptor #
Creates a value of MonitoredResourceDescriptor with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mrdName :: Lens' MonitoredResourceDescriptor (Maybe Text) #
Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".
mrdDisplayName :: Lens' MonitoredResourceDescriptor (Maybe Text) #
Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".
mrdLabels :: Lens' MonitoredResourceDescriptor [LabelDescriptor] #
Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".
mrdType :: Lens' MonitoredResourceDescriptor (Maybe Text) #
Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.
mrdDescription :: Lens' MonitoredResourceDescriptor (Maybe Text) #
Optional. A detailed description of the monitored resource type that might be used in documentation.
ListLogEntriesResponse
data ListLogEntriesResponse #
Result returned from ListLogEntries.
See: listLogEntriesResponse smart constructor.
listLogEntriesResponse :: ListLogEntriesResponse #
Creates a value of ListLogEntriesResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llerNextPageToken :: Lens' ListLogEntriesResponse (Maybe Text) #
If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.
llerEntries :: Lens' ListLogEntriesResponse [LogEntry] #
A list of log entries.
MonitoredResourceLabels
data MonitoredResourceLabels #
Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels "database_id" and "zone".
See: monitoredResourceLabels smart constructor.
Arguments
| :: HashMap Text Text | |
| -> MonitoredResourceLabels |
Creates a value of MonitoredResourceLabels with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
LogMetricVersion
data LogMetricVersion #
Output only. The API version that created or updated this metric. The version also dictates the syntax of the filter expression. When a value for this field is missing, the default value of V2 should be assumed.
Instances
ListLogMetricsResponse
data ListLogMetricsResponse #
Result returned from ListLogMetrics.
See: listLogMetricsResponse smart constructor.
listLogMetricsResponse :: ListLogMetricsResponse #
Creates a value of ListLogMetricsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llmrMetrics :: Lens' ListLogMetricsResponse [LogMetric] #
A list of logs-based metrics.
llmrNextPageToken :: Lens' ListLogMetricsResponse (Maybe Text) #
If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
WriteLogEntriesRequest
data WriteLogEntriesRequest #
The parameters to WriteLogEntries.
See: writeLogEntriesRequest smart constructor.
writeLogEntriesRequest :: WriteLogEntriesRequest #
Creates a value of WriteLogEntriesRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wlerEntries :: Lens' WriteLogEntriesRequest [LogEntry] #
Required. The log entries to write. Values supplied for the fields log_name, resource, and labels in this entries.write request are added to those log entries that do not provide their own values for the fields.To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should write multiple log entries at once rather than calling this method for each individual log entry.
wlerPartialSuccess :: Lens' WriteLogEntriesRequest (Maybe Bool) #
Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, the response status will be the error associated with one of the failed entries and include error details in the form of WriteLogEntriesPartialErrors.
wlerResource :: Lens' WriteLogEntriesRequest (Maybe MonitoredResource) #
Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example: { "type": "gce_instance", "labels": { "zone": "us-central1-a", "instance_id": "00000000000000000000" }} See LogEntry.
wlerLabels :: Lens' WriteLogEntriesRequest (Maybe WriteLogEntriesRequestLabels) #
Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.
wlerLogName :: Lens' WriteLogEntriesRequest (Maybe Text) #
Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" or "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry.
LogSinkOutputVersionFormat
data LogSinkOutputVersionFormat #
Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
Constructors
| LSOVFVersionFormatUnspecified |
|
| LSOVFV2 |
|
| LSOVFV1 |
|
Instances
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
See: empty smart constructor.
LogEntryLabels
data LogEntryLabels #
Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
See: logEntryLabels smart constructor.
Instances
Arguments
| :: HashMap Text Text | |
| -> LogEntryLabels |
Creates a value of LogEntryLabels with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ListSinksResponse
data ListSinksResponse #
Result returned from ListSinks.
See: listSinksResponse smart constructor.
listSinksResponse :: ListSinksResponse #
Creates a value of ListSinksResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsrSinks :: Lens' ListSinksResponse [LogSink] #
A list of sinks.
lsrNextPageToken :: Lens' ListSinksResponse (Maybe Text) #
If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.
RequestLog
data RequestLog #
Complete log information about a single HTTP request to an App Engine application.
See: requestLog smart constructor.
Instances
Creates a value of RequestLog with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rlTraceIdrlInstanceIdrlStatusrlRequestIdrlInstanceIndexrlModuleIdrlVersionIdrlHTTPVersionrlTaskNamerlPendingTimerlWasLoadingRequestrlFirstrlStartTimerlLatencyrlURLMapEntryrlCostrlReferrerrlLinerlIPrlAppIdrlMethodrlResourcerlEndTimerlFinishedrlMegaCyclesrlUserAgentrlNicknamerlHostrlTaskQueueNamerlResponseSizerlSourceReferencerlAppEngineRelease
rlInstanceId :: Lens' RequestLog (Maybe Text) #
An identifier for the instance that handled the request.
rlRequestId :: Lens' RequestLog (Maybe Text) #
Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier.
rlInstanceIndex :: Lens' RequestLog (Maybe Int32) #
If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1.
rlModuleId :: Lens' RequestLog (Maybe Text) #
Module of the application that handled this request.
rlVersionId :: Lens' RequestLog (Maybe Text) #
Version of the application that handled this request.
rlHTTPVersion :: Lens' RequestLog (Maybe Text) #
HTTP version of request. Example: "HTTP/1.1".
rlTaskName :: Lens' RequestLog (Maybe Text) #
Task name of the request, in the case of an offline request.
rlPendingTime :: Lens' RequestLog (Maybe Scientific) #
Time this request spent in the pending request queue.
rlWasLoadingRequest :: Lens' RequestLog (Maybe Bool) #
Whether this was a loading request for the instance.
rlFirst :: Lens' RequestLog (Maybe Bool) #
Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.
rlStartTime :: Lens' RequestLog (Maybe UTCTime) #
Time when the request started.
rlLatency :: Lens' RequestLog (Maybe Scientific) #
Latency of the request.
rlURLMapEntry :: Lens' RequestLog (Maybe Text) #
File or class that handled the request.
rlCost :: Lens' RequestLog (Maybe Double) #
An indication of the relative cost of serving this request.
rlReferrer :: Lens' RequestLog (Maybe Text) #
Referrer URL of request.
rlLine :: Lens' RequestLog [LogLine] #
A list of log lines emitted by the application while serving this request.
rlMethod :: Lens' RequestLog (Maybe Text) #
Request method. Example: "GET", "HEAD", "PUT", "POST", "DELETE".
rlResource :: Lens' RequestLog (Maybe Text) #
Contains the path and query portion of the URL that was requested. For example, if the URL was "http://example.com/app?name=val", the resource would be "/app?name=val". The fragment identifier, which is identified by the # character, is not included.
rlFinished :: Lens' RequestLog (Maybe Bool) #
Whether this request is finished or active.
rlMegaCycles :: Lens' RequestLog (Maybe Int64) #
Number of CPU megacycles used to process request.
rlUserAgent :: Lens' RequestLog (Maybe Text) #
User agent that made the request.
rlNickname :: Lens' RequestLog (Maybe Text) #
The logged-in user who made the request.Most likely, this is the part of the user's email before the ' sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21.
rlHost :: Lens' RequestLog (Maybe Text) #
Internet host and port number of the resource being requested.
rlTaskQueueName :: Lens' RequestLog (Maybe Text) #
Queue name of the request, in the case of an offline request.
rlResponseSize :: Lens' RequestLog (Maybe Int64) #
Size in bytes sent back to client by request.
rlSourceReference :: Lens' RequestLog [SourceReference] #
Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.
rlAppEngineRelease :: Lens' RequestLog (Maybe Text) #
App Engine release version.
LogEntryProtoPayload
data LogEntryProtoPayload #
The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.
See: logEntryProtoPayload smart constructor.
Arguments
| :: HashMap Text JSONValue | |
| -> LogEntryProtoPayload |
Creates a value of LogEntryProtoPayload with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
leppAddtional :: Lens' LogEntryProtoPayload (HashMap Text JSONValue) #
Properties of the object. Contains field 'type with type URL.
LogEntrySourceLocation
data LogEntrySourceLocation #
Additional information about the source code location that produced the log entry.
See: logEntrySourceLocation smart constructor.
logEntrySourceLocation :: LogEntrySourceLocation #
Creates a value of LogEntrySourceLocation with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
leslFunction :: Lens' LogEntrySourceLocation (Maybe Text) #
Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).
leslLine :: Lens' LogEntrySourceLocation (Maybe Int64) #
Optional. Line within the source file. 1-based; 0 indicates no line number available.
leslFile :: Lens' LogEntrySourceLocation (Maybe Text) #
Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.
WriteLogEntriesResponse
data WriteLogEntriesResponse #
Result returned from WriteLogEntries. empty
See: writeLogEntriesResponse smart constructor.
writeLogEntriesResponse :: WriteLogEntriesResponse #
Creates a value of WriteLogEntriesResponse with the minimum fields required to make a request.
LogSink
Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project or organization.
See: logSink smart constructor.
Creates a value of LogSink with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsDestination :: Lens' LogSink (Maybe Text) #
Required. The export destination: "storage.googleapis.com/[GCS_BUCKET]" "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks.
lsStartTime :: Lens' LogSink (Maybe UTCTime) #
Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
lsOutputVersionFormat :: Lens' LogSink (Maybe LogSinkOutputVersionFormat) #
Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
lsWriterIdentity :: Lens' LogSink (Maybe Text) #
Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
lsName :: Lens' LogSink (Maybe Text) #
Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
lsEndTime :: Lens' LogSink (Maybe UTCTime) #
Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
lsFilter :: Lens' LogSink (Maybe Text) #
Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format: logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
ListLogsResponse
data ListLogsResponse #
Result returned from ListLogs.
See: listLogsResponse smart constructor.
listLogsResponse :: ListLogsResponse #
Creates a value of ListLogsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llrNextPageToken :: Lens' ListLogsResponse (Maybe Text) #
If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
llrLogNames :: Lens' ListLogsResponse [Text] #
A list of log names. For example, "projects/my-project/syslog" or "organizations/123/cloudresourcemanager.googleapis.com%2Factivity".
ListMonitoredResourceDescriptorsResponse
data ListMonitoredResourceDescriptorsResponse #
Result returned from ListMonitoredResourceDescriptors.
See: listMonitoredResourceDescriptorsResponse smart constructor.
Instances
listMonitoredResourceDescriptorsResponse :: ListMonitoredResourceDescriptorsResponse #
Creates a value of ListMonitoredResourceDescriptorsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lmrdrNextPageToken :: Lens' ListMonitoredResourceDescriptorsResponse (Maybe Text) #
If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
lmrdrResourceDescriptors :: Lens' ListMonitoredResourceDescriptorsResponse [MonitoredResourceDescriptor] #
A list of resource descriptors.
LabelDescriptorValueType
data LabelDescriptorValueType #
The type of data that can be assigned to the label.
Constructors
| String |
|
| Bool |
|
| INT64 |
|
Instances
HTTPRequest
data HTTPRequest #
A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.
See: hTTPRequest smart constructor.
Instances
Creates a value of HTTPRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
httprStatus :: Lens' HTTPRequest (Maybe Int32) #
The response code indicating the status of response. Examples: 200, 404.
httprRequestURL :: Lens' HTTPRequest (Maybe Text) #
The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: "http://example.com/some/info?color=red".
httprCacheFillBytes :: Lens' HTTPRequest (Maybe Int64) #
The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
httprRemoteIP :: Lens' HTTPRequest (Maybe Text) #
The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: "192.168.1.1", "FE80::0202:B3FF:FE1E:8329".
httprLatency :: Lens' HTTPRequest (Maybe Scientific) #
The request processing latency on the server, from the time the request was received until the response was sent.
httprServerIP :: Lens' HTTPRequest (Maybe Text) #
The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
httprRequestSize :: Lens' HTTPRequest (Maybe Int64) #
The size of the HTTP request message in bytes, including the request headers and the request body.
httprCacheValidatedWithOriginServer :: Lens' HTTPRequest (Maybe Bool) #
Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.
httprUserAgent :: Lens' HTTPRequest (Maybe Text) #
The user agent sent by the client. Example: "Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)".
httprCacheLookup :: Lens' HTTPRequest (Maybe Bool) #
Whether or not a cache lookup was attempted.
httprResponseSize :: Lens' HTTPRequest (Maybe Int64) #
The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
httprRequestMethod :: Lens' HTTPRequest (Maybe Text) #
The request method. Examples: "GET", "HEAD", "PUT", "POST".
httprCacheHit :: Lens' HTTPRequest (Maybe Bool) #
Whether or not an entity was served from cache (with or without validation).
httprReferer :: Lens' HTTPRequest (Maybe Text) #
The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
WriteLogEntriesRequestLabels
data WriteLogEntriesRequestLabels #
Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.
See: writeLogEntriesRequestLabels smart constructor.
writeLogEntriesRequestLabels #
Arguments
| :: HashMap Text Text | |
| -> WriteLogEntriesRequestLabels |
Creates a value of WriteLogEntriesRequestLabels with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
MonitoredResource
data MonitoredResource #
An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone": { "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }}
See: monitoredResource smart constructor.
monitoredResource :: MonitoredResource #
Creates a value of MonitoredResource with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mrLabels :: Lens' MonitoredResource (Maybe MonitoredResourceLabels) #
Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels "database_id" and "zone".
mrType :: Lens' MonitoredResource (Maybe Text) #
Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is "cloudsql_database".
Xgafv
V1 error format.
LogLine
Application log line emitted while processing a request.
See: logLine smart constructor.
Creates a value of LogLine with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llSeverity :: Lens' LogLine (Maybe LogLineSeverity) #
Severity of this log entry.
llSourceLocation :: Lens' LogLine (Maybe SourceLocation) #
Where in the source code this log message was written.
LabelDescriptor
data LabelDescriptor #
A description of a label.
See: labelDescriptor smart constructor.
labelDescriptor :: LabelDescriptor #
Creates a value of LabelDescriptor with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ldValueType :: Lens' LabelDescriptor (Maybe LabelDescriptorValueType) #
The type of data that can be assigned to the label.
ldDescription :: Lens' LabelDescriptor (Maybe Text) #
A human-readable description for the label.
ListLogEntriesRequest
data ListLogEntriesRequest #
The parameters to ListLogEntries.
See: listLogEntriesRequest smart constructor.
listLogEntriesRequest :: ListLogEntriesRequest #
Creates a value of ListLogEntriesRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llerOrderBy :: Lens' ListLogEntriesRequest (Maybe Text) #
Optional. How the results should be sorted. Presently, the only permitted values are "timestamp asc" (default) and "timestamp desc". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of LogEntry.insertId.
llerProjectIds :: Lens' ListLogEntriesRequest [Text] #
Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: "my-project-1A". If present, these project identifiers are converted to resource name format and added to the list of resources in resource_names.
llerFilter :: Lens' ListLogEntriesRequest (Maybe Text) #
Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.
llerPageToken :: Lens' ListLogEntriesRequest (Maybe Text) #
Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
llerPageSize :: Lens' ListLogEntriesRequest (Maybe Int32) #
Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
llerResourceNames :: Lens' ListLogEntriesRequest [Text] #
Required. Names of one or more resources from which to retrieve log entries: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" Projects listed in the project_ids field are added to this list.
LogEntryOperation
data LogEntryOperation #
Additional information about a potentially long-running operation with which a log entry is associated.
See: logEntryOperation smart constructor.
logEntryOperation :: LogEntryOperation #
Creates a value of LogEntryOperation with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
leoFirst :: Lens' LogEntryOperation (Maybe Bool) #
Optional. Set this to True if this is the first log entry in the operation.
leoProducer :: Lens' LogEntryOperation (Maybe Text) #
Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: "MyDivision.MyBigCompany.com", "github.com/MyProject/MyApplication".
leoLast :: Lens' LogEntryOperation (Maybe Bool) #
Optional. Set this to True if this is the last log entry in the operation.
leoId :: Lens' LogEntryOperation (Maybe Text) #
Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.
LogMetric
Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.
See: logMetric smart constructor.
Creates a value of LogMetric with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lmName :: Lens' LogMetric (Maybe Text) #
Required. The client-assigned metric identifier. Examples: "error_count", "nginx/requests".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.The metric identifier in this field must not be URL-encoded (https://en.wikipedia.org/wiki/Percent-encoding). However, when the metric identifier appears as the [METRIC_ID] part of a metric_name API parameter, then the metric identifier must be URL-encoded. Example: "projects/my-project/metrics/nginx%2Frequests".
lmVersion :: Lens' LogMetric (Maybe LogMetricVersion) #
Output only. The API version that created or updated this metric. The version also dictates the syntax of the filter expression. When a value for this field is missing, the default value of V2 should be assumed.
lmFilter :: Lens' LogMetric (Maybe Text) #
Required. An advanced logs filter which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters.
lmDescription :: Lens' LogMetric (Maybe Text) #
Optional. A description of this metric, which is used in documentation.
LogEntry
An individual entry in a log.
See: logEntry smart constructor.
Creates a value of LogEntry with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
leOperation :: Lens' LogEntry (Maybe LogEntryOperation) #
Optional. Information about an operation associated with the log entry, if applicable.
leSeverity :: Lens' LogEntry (Maybe LogEntrySeverity) #
Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.
leTextPayload :: Lens' LogEntry (Maybe Text) #
The log entry payload, represented as a Unicode string (UTF-8).
leJSONPayload :: Lens' LogEntry (Maybe LogEntryJSONPayload) #
The log entry payload, represented as a structure that is expressed as a JSON object.
leHTTPRequest :: Lens' LogEntry (Maybe HTTPRequest) #
Optional. Information about the HTTP request associated with this log entry, if applicable.
leResource :: Lens' LogEntry (Maybe MonitoredResource) #
Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.
leInsertId :: Lens' LogEntry (Maybe Text) #
Optional. A unique ID for the log entry. If you provide this field, the logging service considers other log entries in the same project with the same ID as duplicates which can be removed. If omitted, Stackdriver Logging will generate a unique ID for this log entry.
leLabels :: Lens' LogEntry (Maybe LogEntryLabels) #
Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
leProtoPayload :: Lens' LogEntry (Maybe LogEntryProtoPayload) #
The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.
leSourceLocation :: Lens' LogEntry (Maybe LogEntrySourceLocation) #
Optional. Source code location information associated with the log entry, if any.
leLogName :: Lens' LogEntry (Maybe Text) #
Required. The resource name of the log to which this log entry belongs: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" [LOG_ID] must be URL-encoded within log_name. Example: "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.
leTimestamp :: Lens' LogEntry (Maybe UTCTime) #
Optional. The time the event described by the log entry occurred. If omitted, Stackdriver Logging will use the time the log entry is received.
leTrace :: Lens' LogEntry (Maybe Text) #
Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824
SourceLocation
data SourceLocation #
Specifies a location in a source code file.
See: sourceLocation smart constructor.
Instances
sourceLocation :: SourceLocation #
Creates a value of SourceLocation with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
slFunctionName :: Lens' SourceLocation (Maybe Text) #
Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information is used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).
slFile :: Lens' SourceLocation (Maybe Text) #
Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.
LogEntrySeverity
data LogEntrySeverity #
Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.
Constructors
| Default |
|
| Debug |
|
| Info |
|
| Notice |
|
| Warning |
|
| Error' |
|
| Critical |
|
| Alert |
|
| Emergency |
|
Instances
SourceReference
data SourceReference #
A reference to a particular snapshot of the source tree used to build and deploy an application.
See: sourceReference smart constructor.
sourceReference :: SourceReference #
Creates a value of SourceReference with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srRepository :: Lens' SourceReference (Maybe Text) #
Optional. A URI string identifying the repository. Example: "https://github.com/GoogleCloudPlatform/kubernetes.git"
srRevisionId :: Lens' SourceReference (Maybe Text) #
The canonical and persistent identifier of the deployed revision. Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b"
LogEntryJSONPayload
data LogEntryJSONPayload #
The log entry payload, represented as a structure that is expressed as a JSON object.
See: logEntryJSONPayload smart constructor.
Arguments
| :: HashMap Text JSONValue | |
| -> LogEntryJSONPayload |
Creates a value of LogEntryJSONPayload with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lejpAddtional :: Lens' LogEntryJSONPayload (HashMap Text JSONValue) #
Properties of the object.
LogLineSeverity
data LogLineSeverity #
Severity of this log entry.
Constructors
| LLSDefault |
|
| LLSDebug |
|
| LLSInfo |
|
| LLSNotice |
|
| LLSWarning |
|
| LLSError' |
|
| LLSCritical |
|
| LLSAlert |
|
| LLSEmergency |
|
Instances