-
Notifications
You must be signed in to change notification settings - Fork 7.6k
/
debug.go
1180 lines (1071 loc) · 39.5 KB
/
debug.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright Istio Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package xds
import (
"encoding/json"
"fmt"
"html/template"
"net"
"net/http"
"net/http/pprof"
"net/netip"
"runtime"
"sort"
"strings"
"sync"
"time"
admin "github.com/envoyproxy/go-control-plane/envoy/admin/v3"
core "github.com/envoyproxy/go-control-plane/envoy/config/core/v3"
wasm "github.com/envoyproxy/go-control-plane/envoy/extensions/filters/http/wasm/v3"
tls "github.com/envoyproxy/go-control-plane/envoy/extensions/transport_sockets/tls/v3"
discoveryv3 "github.com/envoyproxy/go-control-plane/envoy/service/discovery/v3"
"google.golang.org/protobuf/proto"
anypb "google.golang.org/protobuf/types/known/anypb"
"istio.io/istio/pilot/pkg/config/kube/crd"
"istio.io/istio/pilot/pkg/features"
"istio.io/istio/pilot/pkg/model"
"istio.io/istio/pilot/pkg/networking/util"
"istio.io/istio/pilot/pkg/util/protoconv"
"istio.io/istio/pilot/pkg/xds/endpoints"
v3 "istio.io/istio/pilot/pkg/xds/v3"
"istio.io/istio/pkg/config"
"istio.io/istio/pkg/config/schema/resource"
"istio.io/istio/pkg/config/xds"
istiolog "istio.io/istio/pkg/log"
"istio.io/istio/pkg/security"
"istio.io/istio/pkg/util/protomarshal"
"istio.io/istio/pkg/util/sets"
)
var indexTmpl = template.Must(template.New("index").Parse(`<html>
<head>
<title>Pilot Debug Console</title>
</head>
<style>
#endpoints {
font-family: "Trebuchet MS", Arial, Helvetica, sans-serif;
border-collapse: collapse;
}
#endpoints td, #endpoints th {
border: 1px solid #ddd;
padding: 8px;
}
#endpoints tr:nth-child(even){background-color: #f2f2f2;}
#endpoints tr:hover {background-color: #ddd;}
#endpoints th {
padding-top: 12px;
padding-bottom: 12px;
text-align: left;
background-color: black;
color: white;
}
</style>
<body>
<br/>
<p style = "font-family:Arial,Helvetica,sans-serif;">
Note: Use <b>pretty</b> in query string (like <b>debug/configz?pretty</b>) to format the output.
</p>
<table id="endpoints">
<tr><th>Endpoint</th><th>Description</th></tr>
{{range .}}
<tr>
<td><a href='{{.Href}}'>{{.Name}}</a></td><td>{{.Help}}</td>
</tr>
{{end}}
</table>
<br/>
</body>
</html>
`))
// AdsClient defines the data that is displayed on "/adsz" endpoint.
type AdsClient struct {
ConnectionID string `json:"connectionId"`
ConnectedAt time.Time `json:"connectedAt"`
PeerAddress string `json:"address"`
Labels map[string]string `json:"labels"`
Metadata *model.NodeMetadata `json:"metadata,omitempty"`
Locality *core.Locality `json:"locality,omitempty"`
Watches map[string][]string `json:"watches,omitempty"`
}
// AdsClients is collection of AdsClient connected to this Istiod.
type AdsClients struct {
Total int `json:"totalClients"`
Connected []AdsClient `json:"clients,omitempty"`
}
// SyncStatus is the synchronization status between Pilot and a given Envoy
type SyncStatus struct {
ClusterID string `json:"cluster_id,omitempty"`
ProxyID string `json:"proxy,omitempty"`
ProxyType model.NodeType `json:"proxy_type,omitempty"`
ProxyVersion string `json:"proxy_version,omitempty"`
IstioVersion string `json:"istio_version,omitempty"`
ClusterSent string `json:"cluster_sent,omitempty"`
ClusterAcked string `json:"cluster_acked,omitempty"`
ListenerSent string `json:"listener_sent,omitempty"`
ListenerAcked string `json:"listener_acked,omitempty"`
RouteSent string `json:"route_sent,omitempty"`
RouteAcked string `json:"route_acked,omitempty"`
EndpointSent string `json:"endpoint_sent,omitempty"`
EndpointAcked string `json:"endpoint_acked,omitempty"`
ExtensionConfigSent string `json:"extensionconfig_sent,omitempty"`
ExtensionConfigAcked string `json:"extensionconfig_acked,omitempty"`
}
// SyncedVersions shows what resourceVersion of a given resource has been acked by Envoy.
type SyncedVersions struct {
ProxyID string `json:"proxy,omitempty"`
ClusterVersion string `json:"cluster_acked,omitempty"`
ListenerVersion string `json:"listener_acked,omitempty"`
RouteVersion string `json:"route_acked,omitempty"`
EndpointVersion string `json:"endpoint_acked,omitempty"`
}
// InitDebug initializes the debug handlers and adds a debug in-memory registry.
func (s *DiscoveryServer) InitDebug(
mux *http.ServeMux,
enableProfiling bool,
fetchWebhook func() map[string]string,
) *http.ServeMux {
internalMux := http.NewServeMux()
s.AddDebugHandlers(mux, internalMux, enableProfiling, fetchWebhook)
return internalMux
}
func (s *DiscoveryServer) AddDebugHandlers(mux, internalMux *http.ServeMux, enableProfiling bool, webhook func() map[string]string) {
// Debug handlers on HTTP ports are added for backward compatibility.
// They will be exposed on XDS-over-TLS in future releases.
if !features.EnableDebugOnHTTP {
return
}
if enableProfiling {
runtime.SetMutexProfileFraction(features.MutexProfileFraction)
runtime.SetBlockProfileRate(features.MutexProfileFraction)
s.addDebugHandler(mux, internalMux, "/debug/pprof/", "Displays pprof index", pprof.Index)
s.addDebugHandler(mux, internalMux, "/debug/pprof/cmdline", "The command line invocation of the current program", pprof.Cmdline)
s.addDebugHandler(mux, internalMux, "/debug/pprof/profile", "CPU profile", pprof.Profile)
s.addDebugHandler(mux, internalMux, "/debug/pprof/symbol", "Symbol looks up the program counters listed in the request", pprof.Symbol)
s.addDebugHandler(mux, internalMux, "/debug/pprof/trace", "A trace of execution of the current program.", pprof.Trace)
}
mux.HandleFunc("/debug", s.Debug)
if features.EnableUnsafeAdminEndpoints {
s.addDebugHandler(mux, internalMux, "/debug/force_disconnect", "Disconnects a proxy from this Pilot", s.forceDisconnect)
}
s.addDebugHandler(mux, internalMux, "/debug/ecdsz", "Status and debug interface for ECDS", s.ecdsz)
s.addDebugHandler(mux, internalMux, "/debug/edsz", "Status and debug interface for EDS", s.Edsz)
s.addDebugHandler(mux, internalMux, "/debug/ndsz", "Status and debug interface for NDS", s.ndsz)
s.addDebugHandler(mux, internalMux, "/debug/adsz", "Status and debug interface for ADS", s.adsz)
s.addDebugHandler(mux, internalMux, "/debug/adsz?push=true", "Initiates push of the current state to all connected endpoints", s.adsz)
s.addDebugHandler(mux, internalMux, "/debug/syncz", "Synchronization status of all Envoys connected to this Pilot instance", s.Syncz)
s.addDebugHandler(mux, internalMux, "/debug/config_distribution", "Version status of all Envoys connected to this Pilot instance", s.distributedVersions)
s.addDebugHandler(mux, internalMux, "/debug/registryz", "Debug support for registry", s.registryz)
s.addDebugHandler(mux, internalMux, "/debug/endpointz", "Obsolete, use endpointShardz", s.endpointShardz)
s.addDebugHandler(mux, internalMux, "/debug/endpointShardz", "Info about the endpoint shards", s.endpointShardz)
s.addDebugHandler(mux, internalMux, "/debug/cachez", "Info about the internal XDS caches", s.cachez)
s.addDebugHandler(mux, internalMux, "/debug/cachez?sizes=true", "Info about the size of the internal XDS caches", s.cachez)
s.addDebugHandler(mux, internalMux, "/debug/cachez?clear=true", "Clear the XDS caches", s.cachez)
s.addDebugHandler(mux, internalMux, "/debug/configz", "Debug support for config", s.configz)
s.addDebugHandler(mux, internalMux, "/debug/sidecarz", "Debug sidecar scope for a proxy", s.sidecarz)
s.addDebugHandler(mux, internalMux, "/debug/resourcesz", "Debug support for watched resources", s.resourcez)
s.addDebugHandler(mux, internalMux, "/debug/instancesz", "Debug support for service instances", s.instancesz)
s.addDebugHandler(mux, internalMux, "/debug/authorizationz", "Internal authorization policies", s.authorizationz)
s.addDebugHandler(mux, internalMux, "/debug/telemetryz", "Debug Telemetry configuration", s.telemetryz)
s.addDebugHandler(mux, internalMux, "/debug/config_dump", "ConfigDump in the form of the Envoy admin config dump API for passed in proxyID", s.ConfigDump)
s.addDebugHandler(mux, internalMux, "/debug/push_status", "Last PushContext Details", s.pushStatusHandler)
s.addDebugHandler(mux, internalMux, "/debug/pushcontext", "Debug support for current push context", s.pushContextHandler)
s.addDebugHandler(mux, internalMux, "/debug/connections", "Info about the connected XDS clients", s.connectionsHandler)
s.addDebugHandler(mux, internalMux, "/debug/inject", "Active inject template", s.injectTemplateHandler(webhook))
s.addDebugHandler(mux, internalMux, "/debug/mesh", "Active mesh config", s.meshHandler)
s.addDebugHandler(mux, internalMux, "/debug/clusterz", "List remote clusters where istiod reads endpoints", s.clusterz)
s.addDebugHandler(mux, internalMux, "/debug/networkz", "List cross-network gateways", s.networkz)
s.addDebugHandler(mux, internalMux, "/debug/mcsz", "List information about Kubernetes MCS services", s.mcsz)
s.addDebugHandler(mux, internalMux, "/debug/list", "List all supported debug commands in json", s.list)
}
func (s *DiscoveryServer) addDebugHandler(mux *http.ServeMux, internalMux *http.ServeMux,
path string, help string, handler func(http.ResponseWriter, *http.Request),
) {
s.debugHandlers[path] = help
// Add handler without auth. This mux is never exposed on an HTTP server and only used internally
if internalMux != nil {
internalMux.HandleFunc(path, handler)
}
// Add handler with auth; this is expose on an HTTP server
mux.HandleFunc(path, s.allowAuthenticatedOrLocalhost(http.HandlerFunc(handler)))
}
func (s *DiscoveryServer) allowAuthenticatedOrLocalhost(next http.Handler) http.HandlerFunc {
return func(w http.ResponseWriter, req *http.Request) {
// Request is from localhost, no need to authenticate
if isRequestFromLocalhost(req) {
next.ServeHTTP(w, req)
return
}
// Authenticate request with the same method as XDS
authFailMsgs := make([]string, 0)
var ids []string
authRequest := security.AuthContext{Request: req}
for _, authn := range s.Authenticators {
u, err := authn.Authenticate(authRequest)
// If one authenticator passes, return
if u != nil && u.Identities != nil && err == nil {
ids = u.Identities
break
}
authFailMsgs = append(authFailMsgs, fmt.Sprintf("Authenticator %s: %v", authn.AuthenticatorType(), err))
}
if ids == nil {
istiolog.Errorf("Failed to authenticate %s %v", req.URL, authFailMsgs)
// Not including detailed info in the response, XDS doesn't either (returns a generic "authentication failure).
w.WriteHeader(http.StatusUnauthorized)
return
}
// TODO: Check that the identity contains istio-system namespace, else block or restrict to only info that
// is visible to the authenticated SA. Will require changes in docs and istioctl too.
next.ServeHTTP(w, req)
}
}
func isRequestFromLocalhost(r *http.Request) bool {
ip, _, err := net.SplitHostPort(r.RemoteAddr)
if err != nil {
return false
}
userIP, _ := netip.ParseAddr(ip)
return userIP.IsLoopback()
}
// Syncz dumps the synchronization status of all Envoys connected to this Pilot instance
func (s *DiscoveryServer) Syncz(w http.ResponseWriter, req *http.Request) {
namespace := req.URL.Query().Get("namespace")
syncz := make([]SyncStatus, 0)
for _, con := range s.SortedClients() {
node := con.proxy
if node != nil && (namespace == "" || node.GetNamespace() == namespace) {
syncz = append(syncz, SyncStatus{
ProxyID: node.ID,
ProxyType: node.Type,
ClusterID: node.GetClusterID().String(),
IstioVersion: node.GetIstioVersion(),
ClusterSent: con.NonceSent(v3.ClusterType),
ClusterAcked: con.NonceAcked(v3.ClusterType),
ListenerSent: con.NonceSent(v3.ListenerType),
ListenerAcked: con.NonceAcked(v3.ListenerType),
RouteSent: con.NonceSent(v3.RouteType),
RouteAcked: con.NonceAcked(v3.RouteType),
EndpointSent: con.NonceSent(v3.EndpointType),
EndpointAcked: con.NonceAcked(v3.EndpointType),
ExtensionConfigSent: con.NonceSent(v3.ExtensionConfigurationType),
ExtensionConfigAcked: con.NonceAcked(v3.ExtensionConfigurationType),
})
}
}
writeJSON(w, syncz, req)
}
// registryz providees debug support for registry - adding and listing model items.
// Can be combined with the push debug interface to reproduce changes.
func (s *DiscoveryServer) registryz(w http.ResponseWriter, req *http.Request) {
all := s.Env.ServiceDiscovery.Services()
writeJSON(w, all, req)
}
// Dumps info about the endpoint shards, tracked using the new direct interface.
// Legacy registry provides are synced to the new data structure as well, during
// the full push.
func (s *DiscoveryServer) endpointShardz(w http.ResponseWriter, req *http.Request) {
writeJSON(w, s.Env.EndpointIndex.Shardz(), req)
}
func (s *DiscoveryServer) cachez(w http.ResponseWriter, req *http.Request) {
if err := req.ParseForm(); err != nil {
w.WriteHeader(http.StatusBadRequest)
_, _ = w.Write([]byte("Failed to parse request\n"))
return
}
if req.Form.Get("clear") != "" {
s.Cache.ClearAll()
_, _ = w.Write([]byte("Cache cleared\n"))
return
}
if req.Form.Get("sizes") != "" {
snapshot := s.Cache.Snapshot()
raw := make(map[string]int, len(snapshot))
totalSize := 0
for _, resource := range snapshot {
if resource == nil {
continue
}
resourceType := resource.Resource.TypeUrl
sz := len(resource.Resource.GetValue())
raw[resourceType] += sz
totalSize += sz
}
res := make(map[string]string, len(raw))
for k, v := range raw {
res[k] = util.ByteCount(v)
}
res["total"] = util.ByteCount(totalSize)
writeJSON(w, res, req)
return
}
snapshot := s.Cache.Snapshot()
resources := make(map[string][]string, len(snapshot)) // Key is typeUrl and value is resource names.
for _, resource := range snapshot {
if resource == nil {
continue
}
resourceType := resource.Resource.TypeUrl
resources[resourceType] = append(resources[resourceType], resource.Name)
}
writeJSON(w, resources, req)
}
const DistributionTrackingDisabledMessage = "Pilot Version tracking is disabled. It may be enabled by setting the " +
"PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING environment variable to true."
func (s *DiscoveryServer) distributedVersions(w http.ResponseWriter, req *http.Request) {
if !features.EnableDistributionTracking {
w.WriteHeader(http.StatusConflict)
_, _ = fmt.Fprint(w, DistributionTrackingDisabledMessage)
return
}
if resourceID := req.URL.Query().Get("resource"); resourceID != "" {
proxyNamespace := req.URL.Query().Get("proxy_namespace")
knownVersions := make(map[string]string)
var results []SyncedVersions
for _, con := range s.SortedClients() {
// wrap this in independent scope so that panic's don't bypass Unlock...
con.proxy.RLock()
if con.proxy != nil && (proxyNamespace == "" || proxyNamespace == con.proxy.ConfigNamespace) {
// read nonces from our statusreporter to allow for skipped nonces, etc.
results = append(results, SyncedVersions{
ProxyID: con.proxy.ID,
ClusterVersion: s.getResourceVersion(s.StatusReporter.QueryLastNonce(con.ID(), v3.ClusterType),
resourceID, knownVersions),
ListenerVersion: s.getResourceVersion(s.StatusReporter.QueryLastNonce(con.ID(), v3.ListenerType),
resourceID, knownVersions),
RouteVersion: s.getResourceVersion(s.StatusReporter.QueryLastNonce(con.ID(), v3.RouteType),
resourceID, knownVersions),
EndpointVersion: s.getResourceVersion(s.StatusReporter.QueryLastNonce(con.ID(), v3.EndpointType),
resourceID, knownVersions),
})
}
con.proxy.RUnlock()
}
writeJSON(w, results, req)
} else {
w.WriteHeader(http.StatusUnprocessableEntity)
_, _ = fmt.Fprintf(w, "querystring parameter 'resource' is required\n")
}
}
// VersionLen is the Config Version and is only used as the nonce prefix, but we can reconstruct
// it because is is a b64 encoding of a 64 bit array, which will always be 12 chars in length.
// len = ceil(bitlength/(2^6))+1
const VersionLen = 12
func (s *DiscoveryServer) getResourceVersion(nonce, key string, cache map[string]string) string {
if len(nonce) < VersionLen {
return ""
}
configVersion := nonce[:VersionLen]
result, ok := cache[configVersion]
if !ok {
lookupResult, err := s.Env.GetLedger().GetPreviousValue(configVersion, key)
if err != nil {
istiolog.Errorf("Unable to retrieve resource %s at version %s: %v", key, configVersion, err)
lookupResult = ""
}
// update the cache even on an error, because errors will not resolve themselves, and we don't want to
// repeat the same error for many s.adsClients.
cache[configVersion] = lookupResult
return lookupResult
}
return result
}
// kubernetesConfig wraps a config.Config with a custom marshaling method that matches a Kubernetes
// object structure.
type kubernetesConfig struct {
config.Config
}
func (k kubernetesConfig) MarshalJSON() ([]byte, error) {
cfg, err := crd.ConvertConfig(k.Config)
if err != nil {
return nil, err
}
return json.Marshal(cfg)
}
// Config debugging.
func (s *DiscoveryServer) configz(w http.ResponseWriter, req *http.Request) {
configs := make([]kubernetesConfig, 0)
if s.Env == nil || s.Env.ConfigStore == nil {
return
}
s.Env.ConfigStore.Schemas().ForEach(func(schema resource.Schema) bool {
cfg := s.Env.ConfigStore.List(schema.GroupVersionKind(), "")
for _, c := range cfg {
configs = append(configs, kubernetesConfig{c})
}
return false
})
writeJSON(w, configs, req)
}
// SidecarScope debugging
func (s *DiscoveryServer) sidecarz(w http.ResponseWriter, req *http.Request) {
proxyID, con := s.getDebugConnection(req)
if con == nil {
s.errorHandler(w, proxyID, con)
return
}
writeJSON(w, con.proxy.SidecarScope, req)
}
// Resource debugging.
func (s *DiscoveryServer) resourcez(w http.ResponseWriter, req *http.Request) {
schemas := make([]config.GroupVersionKind, 0)
if s.Env != nil && s.Env.ConfigStore != nil {
s.Env.Schemas().ForEach(func(schema resource.Schema) bool {
schemas = append(schemas, schema.GroupVersionKind())
return false
})
}
writeJSON(w, schemas, req)
}
// AuthorizationDebug holds debug information for authorization policy.
type AuthorizationDebug struct {
AuthorizationPolicies *model.AuthorizationPolicies `json:"authorization_policies"`
}
// authorizationz dumps the internal authorization policies.
func (s *DiscoveryServer) authorizationz(w http.ResponseWriter, req *http.Request) {
info := AuthorizationDebug{
AuthorizationPolicies: s.globalPushContext().AuthzPolicies,
}
writeJSON(w, info, req)
}
// AuthorizationDebug holds debug information for authorization policy.
type TelemetryDebug struct {
Telemetries *model.Telemetries `json:"telemetries"`
}
func (s *DiscoveryServer) telemetryz(w http.ResponseWriter, req *http.Request) {
proxyID, con := s.getDebugConnection(req)
if proxyID != "" && con == nil {
// We can't guarantee the Pilot we are connected to has a connection to the proxy we requested
// There isn't a great way around this, but for debugging purposes its suitable to have the caller retry.
w.WriteHeader(http.StatusNotFound)
_, _ = w.Write([]byte("Proxy not connected to this Pilot instance. It may be connected to another instance.\n"))
return
}
if con == nil {
info := TelemetryDebug{
Telemetries: s.globalPushContext().Telemetry,
}
writeJSON(w, info, req)
return
}
writeJSON(w, s.globalPushContext().Telemetry.Debug(con.proxy), req)
}
// connectionsHandler implements interface for displaying current connections.
// It is mapped to /debug/connections.
func (s *DiscoveryServer) connectionsHandler(w http.ResponseWriter, req *http.Request) {
adsClients := &AdsClients{}
connections := s.SortedClients()
adsClients.Total = len(connections)
for _, c := range connections {
adsClient := AdsClient{
ConnectionID: c.ID(),
ConnectedAt: c.ConnectedAt(),
PeerAddress: c.Peer(),
}
adsClients.Connected = append(adsClients.Connected, adsClient)
}
writeJSON(w, adsClients, req)
}
// adsz implements a status and debug interface for ADS.
// It is mapped to /debug/adsz
func (s *DiscoveryServer) adsz(w http.ResponseWriter, req *http.Request) {
if s.handlePushRequest(w, req) {
return
}
proxyID, con := s.getDebugConnection(req)
if proxyID != "" && con == nil {
// We can't guarantee the Pilot we are connected to has a connection to the proxy we requested
// There isn't a great way around this, but for debugging purposes its suitable to have the caller retry.
w.WriteHeader(http.StatusNotFound)
_, _ = w.Write([]byte("Proxy not connected to this Pilot instance. It may be connected to another instance.\n"))
return
}
var connections []*Connection
if con != nil {
connections = []*Connection{con}
} else {
connections = s.SortedClients()
}
adsClients := &AdsClients{}
adsClients.Total = len(connections)
for _, c := range connections {
adsClient := AdsClient{
ConnectionID: c.ID(),
ConnectedAt: c.ConnectedAt(),
PeerAddress: c.Peer(),
Labels: c.proxy.Labels,
Metadata: c.proxy.Metadata,
Locality: c.proxy.Locality,
Watches: map[string][]string{},
}
c.proxy.RLock()
for k, wr := range c.proxy.WatchedResources {
r := wr.ResourceNames
if r == nil {
r = []string{}
}
adsClient.Watches[k] = r
}
c.proxy.RUnlock()
adsClients.Connected = append(adsClients.Connected, adsClient)
}
writeJSON(w, adsClients, req)
}
// ecdsz implements a status and debug interface for ECDS.
// It is mapped to /debug/ecdsz
func (s *DiscoveryServer) ecdsz(w http.ResponseWriter, req *http.Request) {
if s.handlePushRequest(w, req) {
return
}
proxyID, con := s.getDebugConnection(req)
if con == nil {
s.errorHandler(w, proxyID, con)
return
}
dump := s.getConfigDumpByResourceType(con, nil, []string{v3.ExtensionConfigurationType})
if len(dump[v3.ExtensionConfigurationType]) == 0 {
w.WriteHeader(http.StatusNotFound)
return
}
writeJSON(w, dump[v3.ExtensionConfigurationType], req)
}
// ConfigDump returns information in the form of the Envoy admin API config dump for the specified proxy
// The dump will only contain dynamic listeners/clusters/routes and can be used to compare what an Envoy instance
// should look like according to Pilot vs what it currently does look like.
func (s *DiscoveryServer) ConfigDump(w http.ResponseWriter, req *http.Request) {
proxyID, con := s.getDebugConnection(req)
if con == nil {
s.errorHandler(w, proxyID, con)
return
}
if ts := s.getResourceTypes(req); len(ts) != 0 {
resources := s.getConfigDumpByResourceType(con, nil, ts)
configDump := &admin.ConfigDump{}
for _, resource := range resources {
for _, rr := range resource {
configDump.Configs = append(configDump.Configs, rr.Resource)
}
}
writeJSON(w, configDump, req)
return
}
if con.proxy.IsZTunnel() {
resources := s.getConfigDumpByResourceType(con, nil, []string{v3.AddressType})
configDump := &admin.ConfigDump{}
for _, resource := range resources {
for _, rr := range resource {
configDump.Configs = append(configDump.Configs, rr.Resource)
}
}
writeJSON(w, configDump, req)
return
}
includeEds := req.URL.Query().Get("include_eds") == "true"
dump, err := s.connectionConfigDump(con, includeEds)
if err != nil {
handleHTTPError(w, err)
return
}
writeJSON(w, dump, req)
}
func (s *DiscoveryServer) getResourceTypes(req *http.Request) []string {
if shortTypes := req.URL.Query().Get("types"); shortTypes != "" {
ts := strings.Split(shortTypes, ",")
resourceTypes := sets.New[string]()
for _, t := range ts {
resourceTypes.Insert(v3.GetResourceType(t))
}
return resourceTypes.UnsortedList()
}
return nil
}
func (s *DiscoveryServer) getConfigDumpByResourceType(conn *Connection, req *model.PushRequest, ts []string) map[string][]*discoveryv3.Resource {
dumps := make(map[string][]*discoveryv3.Resource)
if req == nil {
req = &model.PushRequest{Push: conn.proxy.LastPushContext, Start: time.Now(), Full: true}
}
for _, resourceType := range ts {
w := conn.proxy.GetWatchedResource(resourceType)
if w == nil {
// Not watched, skip
continue
}
gen := s.findGenerator(resourceType, conn)
if gen == nil {
// No generator found, skip
continue
}
if resource, _, err := gen.Generate(conn.proxy, w, req); err == nil {
for _, rr := range resource {
switch resourceType {
case v3.SecretType:
// Secrets must be redacted
secret := &tls.Secret{}
if err := rr.Resource.UnmarshalTo(secret); err != nil {
istiolog.Warnf("failed to unmarshal secret: %v", err)
continue
}
if secret.GetTlsCertificate() != nil {
secret.GetTlsCertificate().PrivateKey = &core.DataSource{
Specifier: &core.DataSource_InlineBytes{
InlineBytes: []byte("[redacted]"),
},
}
}
rr.Resource = protoconv.MessageToAny(secret)
dumps[resourceType] = append(dumps[resourceType], rr)
case v3.ExtensionConfigurationType:
tce := &core.TypedExtensionConfig{}
if err := rr.GetResource().UnmarshalTo(tce); err != nil {
istiolog.Warnf("failed to unmarshal extension: %v", err)
continue
}
switch tce.TypedConfig.TypeUrl {
case xds.WasmHTTPFilterType:
w := &wasm.Wasm{}
if err := tce.TypedConfig.UnmarshalTo(w); err != nil {
istiolog.Warnf("failed to unmarshal wasm filter: %v", err)
continue
}
// Redact Wasm secret env variable.
vmenvs := w.GetConfig().GetVmConfig().EnvironmentVariables
if vmenvs != nil {
if _, found := vmenvs.KeyValues[model.WasmSecretEnv]; found {
vmenvs.KeyValues[model.WasmSecretEnv] = "<Redacted>"
}
}
dumps[resourceType] = append(dumps[resourceType], &discoveryv3.Resource{
Name: w.Config.Name,
Resource: protoconv.MessageToAny(w),
})
default:
dumps[resourceType] = append(dumps[resourceType], rr)
}
default:
dumps[resourceType] = append(dumps[resourceType], rr)
}
}
} else {
istiolog.Warnf("generate failed for request resource type (%v): %v", resourceType, err)
continue
}
}
return dumps
}
// connectionConfigDump converts the connection internal state into an Envoy Admin API config dump proto
// It is used in debugging to create a consistent object for comparison between Envoy and Pilot outputs
func (s *DiscoveryServer) connectionConfigDump(conn *Connection, includeEds bool) (*admin.ConfigDump, error) {
req := &model.PushRequest{Push: conn.proxy.LastPushContext, Start: time.Now(), Full: true}
version := req.Push.PushVersion
dump := s.getConfigDumpByResourceType(conn, req, []string{
v3.ClusterType,
v3.ListenerType,
v3.RouteType,
v3.SecretType,
v3.EndpointType,
v3.ExtensionConfigurationType,
})
dynamicActiveClusters := make([]*admin.ClustersConfigDump_DynamicCluster, 0)
for _, cluster := range dump[v3.ClusterType] {
dynamicActiveClusters = append(dynamicActiveClusters, &admin.ClustersConfigDump_DynamicCluster{
Cluster: cluster.Resource,
})
}
clustersAny, err := protoconv.MessageToAnyWithError(&admin.ClustersConfigDump{
VersionInfo: version,
DynamicActiveClusters: dynamicActiveClusters,
})
if err != nil {
return nil, err
}
dynamicActiveListeners := make([]*admin.ListenersConfigDump_DynamicListener, 0)
for _, listener := range dump[v3.ListenerType] {
dynamicActiveListeners = append(dynamicActiveListeners, &admin.ListenersConfigDump_DynamicListener{
Name: listener.Name,
ActiveState: &admin.ListenersConfigDump_DynamicListenerState{
Listener: listener.Resource,
VersionInfo: version,
},
})
}
listenersAny, err := protoconv.MessageToAnyWithError(&admin.ListenersConfigDump{
VersionInfo: version,
DynamicListeners: dynamicActiveListeners,
})
if err != nil {
return nil, err
}
dynamicRouteConfig := make([]*admin.RoutesConfigDump_DynamicRouteConfig, 0)
for _, route := range dump[v3.RouteType] {
dynamicRouteConfig = append(dynamicRouteConfig, &admin.RoutesConfigDump_DynamicRouteConfig{
VersionInfo: version,
RouteConfig: route.Resource,
})
}
routesAny, err := protoconv.MessageToAnyWithError(&admin.RoutesConfigDump{
DynamicRouteConfigs: dynamicRouteConfig,
})
if err != nil {
return nil, err
}
dynamicSecretsConfig := make([]*admin.SecretsConfigDump_DynamicSecret, 0)
for _, secret := range dump[v3.SecretType] {
dynamicSecretsConfig = append(dynamicSecretsConfig, &admin.SecretsConfigDump_DynamicSecret{
VersionInfo: version,
Secret: secret.Resource,
})
}
secretsAny, err := protoconv.MessageToAnyWithError(&admin.SecretsConfigDump{
DynamicActiveSecrets: dynamicSecretsConfig,
})
if err != nil {
return nil, err
}
extensionsConfig := make([]*admin.EcdsConfigDump_EcdsFilterConfig, 0)
for _, ext := range dump[v3.ExtensionConfigurationType] {
extensionsConfig = append(extensionsConfig, &admin.EcdsConfigDump_EcdsFilterConfig{
VersionInfo: version,
EcdsFilter: ext.Resource,
})
}
extensionsAny, err := protoconv.MessageToAnyWithError(&admin.EcdsConfigDump{
EcdsFilters: extensionsConfig,
})
if err != nil {
return nil, err
}
var endpointsAny *anypb.Any
// EDS is disabled by default for compatibility with Envoy config_dump interface
if includeEds {
endpointConfig := make([]*admin.EndpointsConfigDump_DynamicEndpointConfig, 0)
for _, endpoint := range dump[v3.EndpointType] {
endpointConfig = append(endpointConfig, &admin.EndpointsConfigDump_DynamicEndpointConfig{
VersionInfo: version,
EndpointConfig: endpoint.Resource,
})
}
endpointsAny, err = protoconv.MessageToAnyWithError(&admin.EndpointsConfigDump{
DynamicEndpointConfigs: endpointConfig,
})
if err != nil {
return nil, err
}
}
bootstrapAny := protoconv.MessageToAny(&admin.BootstrapConfigDump{})
scopedRoutesAny := protoconv.MessageToAny(&admin.ScopedRoutesConfigDump{})
// The config dump must have all configs with connections specified in
// https://www.envoyproxy.io/docs/envoy/latest/api-v2/admin/v2alpha/config_dump.proto
configs := []*anypb.Any{
bootstrapAny,
clustersAny,
}
if includeEds {
configs = append(configs, endpointsAny)
}
configs = append(configs,
listenersAny,
scopedRoutesAny,
routesAny,
secretsAny,
extensionsAny,
)
configDump := &admin.ConfigDump{
Configs: configs,
}
return configDump, nil
}
// injectTemplateHandler dumps the injection template
// Replaces dumping the template at startup.
func (s *DiscoveryServer) injectTemplateHandler(webhook func() map[string]string) func(http.ResponseWriter, *http.Request) {
return func(w http.ResponseWriter, req *http.Request) {
// TODO: we should split the inject template into smaller modules (separate one for dump core, etc),
// and allow pods to select which patches will be selected. When this happen, this should return
// all inject templates or take a param to select one.
if webhook == nil {
w.WriteHeader(http.StatusNotFound)
return
}
writeJSON(w, webhook(), req)
}
}
// meshHandler dumps the mesh config
func (s *DiscoveryServer) meshHandler(w http.ResponseWriter, req *http.Request) {
writeJSON(w, s.Env.Mesh(), req)
}
// pushStatusHandler dumps the last PushContext
func (s *DiscoveryServer) pushStatusHandler(w http.ResponseWriter, req *http.Request) {
model.LastPushMutex.Lock()
defer model.LastPushMutex.Unlock()
if model.LastPushStatus == nil {
return
}
out, err := model.LastPushStatus.StatusJSON()
if err != nil {
handleHTTPError(w, err)
return
}
w.Header().Add("Content-Type", "application/json")
_, _ = w.Write(out)
}
// PushContextDebug holds debug information for push context.
type PushContextDebug struct {
AuthorizationPolicies *model.AuthorizationPolicies
NetworkGateways []model.NetworkGateway
UnresolvedGateways []model.NetworkGateway
}
// pushContextHandler dumps the current PushContext
func (s *DiscoveryServer) pushContextHandler(w http.ResponseWriter, req *http.Request) {
push := PushContextDebug{}
pc := s.globalPushContext()
if pc == nil {
return
}
push.AuthorizationPolicies = pc.AuthzPolicies
if pc.NetworkManager() != nil {
push.NetworkGateways = pc.NetworkManager().AllGateways()
push.UnresolvedGateways = pc.NetworkManager().Unresolved.AllGateways()
}
writeJSON(w, push, req)
}
// Debug lists all the supported debug endpoints.
func (s *DiscoveryServer) Debug(w http.ResponseWriter, req *http.Request) {
type debugEndpoint struct {
Name string
Href string
Help string
}
var deps []debugEndpoint
for k, v := range s.debugHandlers {
deps = append(deps, debugEndpoint{
Name: k,
Href: k,
Help: v,
})
}
sort.Slice(deps, func(i, j int) bool {
return deps[i].Name < deps[j].Name
})
if err := indexTmpl.Execute(w, deps); err != nil {
istiolog.Errorf("Error in rendering index template %v", err)
w.WriteHeader(http.StatusInternalServerError)
}
}
// list all the supported debug commands in json.
func (s *DiscoveryServer) list(w http.ResponseWriter, req *http.Request) {
var cmdNames []string
for k := range s.debugHandlers {
key := strings.Replace(k, "/debug/", "", -1)
// exclude current list command
if key == "list" {
continue
}
// can not support pprof commands
if strings.Contains(key, "pprof") {
continue
}
cmdNames = append(cmdNames, key)
}
sort.Strings(cmdNames)
writeJSON(w, cmdNames, req)
}
// ndsz implements a status and debug interface for NDS.
// It is mapped to /debug/ndsz on the monitor port (15014).
func (s *DiscoveryServer) ndsz(w http.ResponseWriter, req *http.Request) {
if s.handlePushRequest(w, req) {
return
}
proxyID, con := s.getDebugConnection(req)
if con == nil {
s.errorHandler(w, proxyID, con)
return
}
if !con.proxy.Metadata.DNSCapture {
w.WriteHeader(http.StatusBadRequest)
_, _ = w.Write([]byte("DNS capture is not enabled in the proxy\n"))
return
}
if s.Generators[v3.NameTableType] != nil {
nds, _, _ := s.Generators[v3.NameTableType].Generate(con.proxy, nil, &model.PushRequest{
Push: con.proxy.LastPushContext,
Full: true,
})
if len(nds) == 0 {
return
}
writeJSON(w, nds[0], req)
}
}
// Edsz implements a status and debug interface for EDS.
// It is mapped to /debug/edsz on the monitor port (15014).
func (s *DiscoveryServer) Edsz(w http.ResponseWriter, req *http.Request) {
if s.handlePushRequest(w, req) {