libZSservicesZSamazonka-xrayZSamazonka-xray
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.XRay.Types.ServiceInfo

Description

 
Synopsis

Documentation

data ServiceInfo Source #

Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.

See: newServiceInfo smart constructor.

Constructors

ServiceInfo' 

Fields

  • state :: Maybe Text

    The service's state.

  • startTime :: Maybe POSIX

    The start time of the first segment that the service generated.

  • root :: Maybe Bool

    Indicates that the service was the first service to process a request.

  • responseTimeHistogram :: Maybe [HistogramEntry]

    A histogram that maps the spread of service response times.

  • durationHistogram :: Maybe [HistogramEntry]

    A histogram that maps the spread of service durations.

  • referenceId :: Maybe Int

    Identifier for the service. Unique within the service map.

  • accountId :: Maybe Text

    Identifier of the Amazon Web Services account in which the service runs.

  • names :: Maybe [Text]

    A list of names for the service, including the canonical name.

  • name :: Maybe Text

    The canonical name of the service.

  • endTime :: Maybe POSIX

    The end time of the last segment that the service generated.

  • type' :: Maybe Text

    The type of service.

    • Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
    • Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.
    • client - Represents the clients that sent requests to a root service.
    • remote - A downstream service of indeterminate type.
  • edges :: Maybe [Edge]

    Connections to downstream services.

  • summaryStatistics :: Maybe ServiceStatistics

    Aggregated statistics for the service.

Instances

Instances details
Eq ServiceInfo Source # 
Instance details

Defined in Amazonka.XRay.Types.ServiceInfo

Read ServiceInfo Source # 
Instance details

Defined in Amazonka.XRay.Types.ServiceInfo

Show ServiceInfo Source # 
Instance details

Defined in Amazonka.XRay.Types.ServiceInfo

Generic ServiceInfo Source # 
Instance details

Defined in Amazonka.XRay.Types.ServiceInfo

Associated Types

type Rep ServiceInfo :: Type -> Type #

NFData ServiceInfo Source # 
Instance details

Defined in Amazonka.XRay.Types.ServiceInfo

Methods

rnf :: ServiceInfo -> () #

Hashable ServiceInfo Source # 
Instance details

Defined in Amazonka.XRay.Types.ServiceInfo

FromJSON ServiceInfo Source # 
Instance details

Defined in Amazonka.XRay.Types.ServiceInfo

type Rep ServiceInfo Source # 
Instance details

Defined in Amazonka.XRay.Types.ServiceInfo

type Rep ServiceInfo = D1 ('MetaData "ServiceInfo" "Amazonka.XRay.Types.ServiceInfo" "libZSservicesZSamazonka-xrayZSamazonka-xray" 'False) (C1 ('MetaCons "ServiceInfo'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "root") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "responseTimeHistogram") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HistogramEntry])) :*: (S1 ('MetaSel ('Just "durationHistogram") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HistogramEntry])) :*: S1 ('MetaSel ('Just "referenceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: ((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "names") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "edges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Edge])) :*: S1 ('MetaSel ('Just "summaryStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceStatistics)))))))

newServiceInfo :: ServiceInfo Source #

Create a value of ServiceInfo with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:state:ServiceInfo', serviceInfo_state - The service's state.

$sel:startTime:ServiceInfo', serviceInfo_startTime - The start time of the first segment that the service generated.

$sel:root:ServiceInfo', serviceInfo_root - Indicates that the service was the first service to process a request.

$sel:responseTimeHistogram:ServiceInfo', serviceInfo_responseTimeHistogram - A histogram that maps the spread of service response times.

$sel:durationHistogram:ServiceInfo', serviceInfo_durationHistogram - A histogram that maps the spread of service durations.

$sel:referenceId:ServiceInfo', serviceInfo_referenceId - Identifier for the service. Unique within the service map.

$sel:accountId:ServiceInfo', serviceInfo_accountId - Identifier of the Amazon Web Services account in which the service runs.

$sel:names:ServiceInfo', serviceInfo_names - A list of names for the service, including the canonical name.

$sel:name:ServiceInfo', serviceInfo_name - The canonical name of the service.

$sel:endTime:ServiceInfo', serviceInfo_endTime - The end time of the last segment that the service generated.

$sel:type':ServiceInfo', serviceInfo_type - The type of service.

  • Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
  • Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.
  • client - Represents the clients that sent requests to a root service.
  • remote - A downstream service of indeterminate type.

$sel:edges:ServiceInfo', serviceInfo_edges - Connections to downstream services.

$sel:summaryStatistics:ServiceInfo', serviceInfo_summaryStatistics - Aggregated statistics for the service.

serviceInfo_startTime :: Lens' ServiceInfo (Maybe UTCTime) Source #

The start time of the first segment that the service generated.

serviceInfo_root :: Lens' ServiceInfo (Maybe Bool) Source #

Indicates that the service was the first service to process a request.

serviceInfo_responseTimeHistogram :: Lens' ServiceInfo (Maybe [HistogramEntry]) Source #

A histogram that maps the spread of service response times.

serviceInfo_durationHistogram :: Lens' ServiceInfo (Maybe [HistogramEntry]) Source #

A histogram that maps the spread of service durations.

serviceInfo_referenceId :: Lens' ServiceInfo (Maybe Int) Source #

Identifier for the service. Unique within the service map.

serviceInfo_accountId :: Lens' ServiceInfo (Maybe Text) Source #

Identifier of the Amazon Web Services account in which the service runs.

serviceInfo_names :: Lens' ServiceInfo (Maybe [Text]) Source #

A list of names for the service, including the canonical name.

serviceInfo_name :: Lens' ServiceInfo (Maybe Text) Source #

The canonical name of the service.

serviceInfo_endTime :: Lens' ServiceInfo (Maybe UTCTime) Source #

The end time of the last segment that the service generated.

serviceInfo_type :: Lens' ServiceInfo (Maybe Text) Source #

The type of service.

  • Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
  • Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.
  • client - Represents the clients that sent requests to a root service.
  • remote - A downstream service of indeterminate type.

serviceInfo_edges :: Lens' ServiceInfo (Maybe [Edge]) Source #

Connections to downstream services.