logging library

Cloud Logging: log-based metrics and sinks routed to BigQuery / Pub/Sub / Storage / Logging-bucket destinations, plus leftover folder / organization / billing-account buckets, exclusions, sinks, and settings (apply-excluded).

The three sink resources (project, folder, organization) share a common shape but differ in scope: each entry filters only the log stream produced under its respective resource hierarchy. project_sink predates the unified prefix convention and keeps its unprefixed LoggingProjectSinkBigqueryOptions / LoggingProjectSinkLogSinkExclusion helper types; the newer folder and organization sinks use scope-prefixed names to avoid barrel-export collision.

Classes

AppConstant<T>: A value the Stack hands to application code as a static const in the generated AppExports file — known when synth runs, so the app compiles against it.
AppExports: Where synth writes the Dart file application code imports: the Stack's constants, as the static const members of <name>Constants, and a typed reader of its Terraform outputs, <name>Outputs.
AttributeRef<T>: Public for sealed pattern matching, but constructor is private — only TfRef.attribute() may construct instances.
DartDefineOutput: An output whose value is the client build's --dart-define file, registered with Stack.addDartDefineOutput.
Data: Base of every user-instantiable Terraform data block.
DataGoogleLoggingFolderSettings: Factory wrapper for google_logging_folder_settings.
DataGoogleLoggingLogView: Factory wrapper for google_logging_log_view.
DataGoogleLoggingLogViewIamPolicy: Factory wrapper for google_logging_log_view_iam_policy.
DataGoogleLoggingOrganizationSettings: Factory wrapper for google_logging_organization_settings.
DataGoogleLoggingProjectCmekSettings: Factory wrapper for google_logging_project_cmek_settings.
DataGoogleLoggingProjectSettings: Factory wrapper for google_logging_project_settings.
DataGoogleLoggingSink: Factory wrapper for google_logging_sink.
DataRef<T>: Public for sealed pattern matching, but constructor is private — only TfRef.data() may construct instances.
EnvironmentConstant: The AppConstant.fromEnvironment choice.
GcsBackend: terraform { backend "gcs" { ... } } configuration.
GoogleLoggingBillingAccountBucketConfig: Factory wrapper for google_logging_billing_account_bucket_config.
GoogleLoggingBillingAccountExclusion: Factory wrapper for google_logging_billing_account_exclusion.
GoogleLoggingBillingAccountSink: Factory wrapper for google_logging_billing_account_sink.
GoogleLoggingFolderBucketConfig: Factory wrapper for google_logging_folder_bucket_config.
GoogleLoggingFolderExclusion: Factory wrapper for google_logging_folder_exclusion.
GoogleLoggingFolderSettings: Factory wrapper for google_logging_folder_settings.
GoogleLoggingFolderSink: Factory wrapper for google_logging_folder_sink.
GoogleLoggingLinkedDataset: Factory wrapper for google_logging_linked_dataset.
GoogleLoggingLogScope: Factory wrapper for google_logging_log_scope.
GoogleLoggingLogView: Factory wrapper for google_logging_log_view.
GoogleLoggingLogViewIamBinding: Factory wrapper for google_logging_log_view_iam_binding.
GoogleLoggingLogViewIamMember: Factory wrapper for google_logging_log_view_iam_member.
GoogleLoggingLogViewIamPolicy: Factory wrapper for google_logging_log_view_iam_policy.
GoogleLoggingMetric: Factory wrapper for google_logging_metric.
GoogleLoggingOrganizationBucketConfig: Factory wrapper for google_logging_organization_bucket_config.
GoogleLoggingOrganizationExclusion: Factory wrapper for google_logging_organization_exclusion.
GoogleLoggingOrganizationSettings: Factory wrapper for google_logging_organization_settings.
GoogleLoggingOrganizationSink: Factory wrapper for google_logging_organization_sink.
GoogleLoggingProjectBucketConfig: Factory wrapper for google_logging_project_bucket_config.
GoogleLoggingProjectExclusion: Factory wrapper for google_logging_project_exclusion.
GoogleLoggingProjectSink: Factory wrapper for google_logging_project_sink.
GoogleLoggingSavedQuery: Factory wrapper for google_logging_saved_query.
IgnoreAllChanges: IgnoreChanges.all.
IgnoreAttributes: IgnoreChanges.of.
IgnoreChanges: What ignore_changes covers: every attribute, or the listed ones.
InvalidDartDefineOutput: An output of Stack.addDartDefineOutput that cannot carry what it names: an output that is not registered, is sensitive or has no environment value, two outputs read from one variable, or no output at all.
InvalidLifecycle: A lifecycle block Terraform rejects: a data source (or one of its attributes) in replaceTriggeredBy, all inside IgnoreChanges.of, or a condition with an empty error message.
InvalidMoveTarget: A moved block whose to names no resource of the Stack.
InvalidTimeout: A negative timeouts duration.
LifecycleCondition: A precondition or postcondition block: Terraform fails the plan (LifecycleCondition.pre) or the apply (LifecycleCondition.post) with errorMessage when condition is false.
LifecycleOptions: lifecycle { ... } block on a resource.
LocalBackend: terraform { backend "local" { ... } } configuration.
LoggingBillingAccountBucketConfigCmekSettings: Typed helper for the cmek_settings block of google_logging_billing_account_bucket_config (derived from provider schema).
LoggingBillingAccountBucketConfigIndexConfigs: Typed helper for the index_configs block of google_logging_billing_account_bucket_config (derived from provider schema).
LoggingBillingAccountSinkBigqueryOptions: Typed helper for the bigquery_options block of google_logging_billing_account_sink (derived from provider schema).
LoggingBillingAccountSinkExclusions: Typed helper for the exclusions block of google_logging_billing_account_sink (derived from provider schema).
LoggingFolderBucketConfigCmekSettings: Typed helper for the cmek_settings block of google_logging_folder_bucket_config (derived from provider schema).
LoggingFolderBucketConfigIndexConfigs: Typed helper for the index_configs block of google_logging_folder_bucket_config (derived from provider schema).
LoggingFolderSinkBigqueryOptions: bigquery_options block for google_logging_folder_sink. Toggles partitioned tables for BigQuery destinations (date-sharded vs. partitioned by _PARTITIONTIME).
LoggingFolderSinkExclusion: One entry in the exclusions list for google_logging_folder_sink. Log entries matching filter are dropped before being routed to the sink's destination. name must be unique within the sink.
LoggingLinkedDatasetBigqueryDataset: bigquery_dataset block — destination dataset for log analytics.
LoggingLogViewIamBindingCondition: Typed helper for the condition block of google_logging_log_view_iam_binding (derived from provider schema).
LoggingLogViewIamMemberCondition: Typed helper for the condition block of google_logging_log_view_iam_member (derived from provider schema).
LoggingMetricBucketOptions: bucket_options block (max=1) — histogram bucket boundaries for a DISTRIBUTION metric. Pick EXACTLY one of linearBuckets, exponentialBuckets, or explicitBuckets; Terraform enforces the exactly_one_of contract at apply time.
LoggingMetricDescriptor: metric_descriptor block (max=1) — describes the shape of the metric produced by the surrounding GoogleLoggingMetric. When omitted, the API defaults to a DELTA / INT64 counter with unit "1".
LoggingMetricExplicitBuckets: bucket_options.explicit_buckets (max=1). Specifies arbitrary bucket widths via a monotonically-increasing list of bounds.
LoggingMetricExponentialBuckets: bucket_options.exponential_buckets (max=1). Produces an exponential sequence of buckets where bucket i upper bound is scale * growthFactor^i. growthFactor must be > 1.
LoggingMetricLabel: One entry in metric_descriptor.labels — describes a label that the metric carries. The label value is filled in per log entry via the matching extractor expression in GoogleLoggingMetric.labelExtractors.
LoggingMetricLinearBuckets: bucket_options.linear_buckets (max=1). Produces a linear sequence of buckets that all have the same width (except the implicit overflow / underflow buckets).
LoggingOrganizationBucketConfigCmekSettings: Typed helper for the cmek_settings block of google_logging_organization_bucket_config (derived from provider schema).
LoggingOrganizationBucketConfigIndexConfigs: Typed helper for the index_configs block of google_logging_organization_bucket_config (derived from provider schema).
LoggingOrganizationSinkBigqueryOptions: bigquery_options block for google_logging_organization_sink. Toggles partitioned tables for BigQuery destinations (date-sharded vs. partitioned by _PARTITIONTIME).
LoggingOrganizationSinkExclusion: One entry in the exclusions list for google_logging_organization_sink. Log entries matching filter are dropped before being routed to the sink's destination. name must be unique within the sink.
LoggingProjectBucketConfigCmekSettings: Typed helper for the cmek_settings block of google_logging_project_bucket_config (derived from provider schema).
LoggingProjectBucketConfigIndexConfigs: Typed helper for the index_configs block of google_logging_project_bucket_config (derived from provider schema).
LoggingProjectSinkBigqueryOptions: bigquery_options block. Toggles partitioned tables for BigQuery destinations (date-sharded vs. partitioned by _PARTITIONTIME).
LoggingProjectSinkLogSinkExclusion: One entry in the exclusions list. Log entries matching filter are dropped before being routed to the sink's destination. name must be unique within the sink.
LoggingSavedQueryDefinition: Exactly one of logging_query, ops_analytics_query on google_logging_saved_query: the provider rejects none and more than one, so each variant sets one of them.
LoggingSavedQueryDefinitionLoggingQuery: The LoggingSavedQueryDefinition.loggingQuery choice: sets logging_query.
LoggingSavedQueryDefinitionOpsAnalyticsQuery: The LoggingSavedQueryDefinition.opsAnalyticsQuery choice: sets ops_analytics_query.
LoggingSavedQueryLoggingQuery: Typed helper for the logging_query block of google_logging_saved_query (derived from provider schema).
LoggingSavedQueryOpsAnalyticsQuery: Typed helper for the ops_analytics_query block of google_logging_saved_query (derived from provider schema).
LoggingSavedQuerySummaryField: At most one of summary_field_start, summary_field_end on the logging_query block of google_logging_saved_query: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
LoggingSavedQuerySummaryFieldEnd: The LoggingSavedQuerySummaryField.summaryFieldEnd choice: sets summary_field_end.
LoggingSavedQuerySummaryFields: Typed helper for the logging_query.summary_fields block of google_logging_saved_query (derived from provider schema).
LoggingSavedQuerySummaryFieldStart: The LoggingSavedQuerySummaryField.summaryFieldStart choice: sets summary_field_start.
MissingProvider: A block needs a provider configuration the Stack does not register: the provider its type implies (google for google_pubsub_topic), the one its provider meta-argument names, or one a module call passes on.
ModuleCall: A module "<localName>" { ... } call as a Dart value.
NoProviders: The Stack registers no provider, but declares resources or data sources.
ProviderConflict: Two provider registrations Terraform rejects together: two defaults of one name, a repeated alias, an alias that is not an identifier, or configurations of one name with different source / version constraints.
RefConstant<T>: The AppConstant.ref choice.
ReplaceTrigger: What lifecycle.replaceTriggeredBy lists: a resource of the Stack or an attribute getter of one. Resource and TfRef implement it; synth reports a data source or a data-source attribute as an InvalidLifecycle.
Resource: Base of every user-instantiable Terraform resource.
ResourceRef: Public for sealed pattern matching, but constructor is private — only TfRef.resource() may construct instances.
S3Backend: terraform { backend "s3" { ... } } configuration.
Sensitive<T>: What an argument Terraform marks sensitive takes: a variable, an expression or an attribute getter — a value Terraform resolves, never a Dart literal that would be written into main.tf.json.
SensitiveLiteral: A sensitive field is set to a literal, which would write the secret in plain text into main.tf.json.
Stack: User-extended IaC composition root.
StackBackend: Lightweight backend hook. Core ships GcsBackend, S3Backend, and LocalBackend; anything else implements this interface in the caller. The Stack only stores the value and exposes a discriminator for synth's terraform { backend ... } emitter.
StackProvider: Coordination interface between Stack (in this package) and concrete providers (e.g. GoogleProvider in terradart_google). Concrete providers implement every getter using their baked-in constants from Stage 2 codegen.
SynthIssue: One reason a Stack cannot be synthesized.
SynthResult: Bundle returned by StackSynth.synth.
TfAddressed: Anything that exposes a Terraform address, e.g. google_pubsub_topic.orders.
TfArg<T>: A Terraform argument: a Dart-side literal, a reference to another block's attribute (TfRef), a variable or a raw expression.
TfArgExpression<T>: A raw Terraform expression — the tf.json template string, verbatim.
TfArgLiteral<T>
TfArgVariable<T>
TfCollectionType: list(...), set(...) or map(...).
TfMoved: One moved { from = ... to = ... } block: the state object at from now belongs to the resource at to, so a rename does not become a destroy-and-create.
TfObjectType: object({ ... }).
TfOptionalType: optional(<type>[, <default>]).
TfOutput<T>: An output "<name>" { value = ... } block, registered with Stack.addOutput.
TfPrimitiveType: string, number, bool or any.
TfRef<T>: A Terraform-side reference: an attribute of a resource (AttributeRef) or a data source (DataRef), or a whole resource (ResourceRef).
TfTimeouts: timeouts { ... } on a resource or data source: how long Terraform waits for each operation before giving up.
TfTupleType: tuple([...]).
TfType: A Terraform type constraint: string, list(number), object({ name = string }).
TfVariable: One variable "<name>" { ... } declaration.
UndeclaredVariable: A TfArg.variable or var.<name> in an expression names a variable the Stack does not declare.
UnregisteredReference: A block references another block that was never registered on the Stack: built, but not passed to add(...) / addModule(...).
UnresolvableConstant: An AppConstant.ref whose value is not known at synth: the attribute is not set to a literal, is sensitive, does not match the constant's type, or belongs to a block that is not registered.
ValueConstant<T>: The AppConstant.value choice.

Enums

ResourceKind: Whether a Stack entry is a resource block or a data block in Terraform JSON.

Extension Types

LoggingMetricKind: metric_descriptor.metric_kind — whether the metric records instantaneous values, deltas, or running totals. For counter metrics (the typical logs-based shape) use LoggingMetricKind.delta.
LoggingMetricLabelValueType: metric_descriptor.labels[].value_type — the data type of a label extracted from log entries. The label-level value space is narrower than the descriptor's (no DOUBLE / DISTRIBUTION / MONEY). Defaults to LoggingMetricLabelValueType.string when omitted.
LoggingMetricValueType: metric_descriptor.value_type — the value kind recorded per data point. Use LoggingMetricValueType.int64 for counter metrics and LoggingMetricValueType.distribution when pairing with LoggingMetricBucketOptions to build a histogram from GoogleLoggingMetric.valueExtractor.
LoggingSavedQueryVisibility: Logging Saved Query enum for visibility.
OutputEnvironment: The environment Stack.outputEnvironment returns: each variable and its value, in registration order.
RefTo: A reference to a resource of type R, for an argument that names another resource (network, vpc_id, role_arn, ...).

Extensions

RefToList on TfArg<List<RefTo<R>>>: A list-valued reference argument (security_group_ids, subnet_ids): a literal list of RefTos, or one value that is the whole list (TfArg.variable('subnet_ids'), TfArg.expression(...)).
TerraformDurationExt on Duration: Converts a Dart Duration into a Terraform duration string ("604800s").

Constants

terradartManifestVariable → const String: The environment variable the terradart command sets to the file runStack and runEnvironments describe what they wrote in.

Functions

runEnvironments<E extends Enum>(List<String> args, List<E> environments, Stack build(E env), {String dir(E env)?, String? workspace(E env)?, List<String> backendConfig(E env)?, E? defaultEnv}) → Future<void>: The entry point of a project with one Stack per environment. The environments are the members of an enum of the project's own — any names, each carrying its values — so the Stack takes a typed env and derives everything per environment from it, its backend included:
runStack(List<String> args, Stack build(), {String out = 'tf-out'}) → Future<void>: The entry point of a project with one Stack: writes it to out.

Exceptions / Errors

DuplicateModuleError: A ModuleCall registered twice under one name.
DuplicateResourceError: Thrown by Stack.add when an entry with the same (kind, terraformType, localName) triple is registered twice.
SynthException: Thrown by Stack.synth() and Stack.writeTo() when the Stack has one or more SynthIssues. Nothing is written.

logging library

Classes

Enums

Extension Types

Extensions

Constants

Functions

Exceptions / Errors

terradart_google package

logging library